Manufik API

Stock, purchasing and production of one company, for a program: a web shop that issues what it sold, a script that creates parts, another system that reads stock levels.

Base address
https://manufik.eu/api/v1
Authentication
Authorization: Bearer mfk_…
Format
JSON · 57 operations

Authentication

Every request carries an API key. The company’s owner makes one in Settings → Users → API, gives it one of the company’s roles, and is shown it once.

curl https://manufik.eu/api/v1/parts \
  -H "Authorization: Bearer mfk_…"
  • A key belongs to one company. No path names the company — the key does.
  • It may do what its role may, the same role a person would hold: what it may change, what it may read, and in which warehouses. It is never the owner.
  • Keep it out of source code. A key that may have leaked is revoked in the same screen, at once, and a new one made.

Requests and answers

JSON both ways. Four things are worth knowing before the first request:

  • Money and quantities are decimal strings — "125.00", "0.5" — never floats.
  • Dates are YYYY-MM-DD, in the company’s own day.
  • Long lists come in blocks. An answer that carries next has more; ask again with ?after= set to it.
  • A PATCH changes what it is sent. A field left out is left as it is; a field sent empty is cleared. A PUT replaces the whole.
GET /documents?limit=100
→ { "documents": [ … ], "next": "WyIyMDI2LTAxLTMxIiwiNDEiXQ" }

GET /documents?limit=100&after=WyIyMDI2LTAxLTMxIiwiNDEiXQ
→ { "documents": [ … ] }

Errors

A refusal is application/problem+json. Write programs against code, which is stable; detail is a sentence for a person and may be reworded. Two refusals come from the edge in front of the API rather than from the API, as application/json with the same code, status and detail: 403 gateway.blocked and 429 gateway.rate_limited.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/problem+json

{
  "status": 422,
  "title": "Unprocessable Entity",
  "code": "part.unknown",
  "detail": "line 2: no such part: RES-0603-F-100K",
  "params": { "pn": "RES-0603-F-100K" },
  "line": 2
}
401No key, or none this system will take — missing, not one of this system’s or expired: api.key_invalid; revoked: api.key_revoked. A key that ran out minutes ago may be answered api.key_expired.
403The key’s role may not do this — or, gateway.blocked, the request was refused at the edge as an attack.
404No such thing — or no such operation in the public API, api.not_found.
409The state does not allow it: not enough on the shelf, a closed period, a plan that does not include it.
422The request was understood and cannot be carried out. params names the values the sentence needs, line the line of a document it is about.
429Too fast: gateway.throttled for the company’s programs, gateway.rate_limited for one network address. See rate limits.

Rate limits

A company’s programs share an allowance of their own, set by its plan and apart from its people’s: a program that asks too fast slows the company’s other programs, never the people at their screens. Past it the answer is 429 with Retry-After; wait that long and send again.

The people are limited by network address as well: everything sent from one address to Manufik other than the public API, twenty requests a second over five minutes, is 429 gateway.rate_limited past it, whoever sent it. A program is not counted there, unless its path carries an escaped dot, slash or backslash (%2E, %2F, %5C), a backslash, or an empty or a dot segment — an escaped space or letter, as in a part number, is not counted. People of two companies behind one address are counted together.

The public API has a limit by address of its own: twenty requests a second over five minutes from one address, past which the answer is 429 gateway.rate_limited. That is twice what the dearest plan allows one company’s programs, so one company’s programs that keep to its plan never meet it; programs of several companies sent from one address are counted together.

Sending a request again

A request that timed out may or may not have been carried out, and posting a document twice is the one mistake worth designing against. Give every writing request an Idempotency-Key — any string of your own: an order number, a UUID.

curl -X POST https://manufik.eu/api/v1/documents \
  -H "Authorization: Bearer mfk_…" \
  -H "Idempotency-Key: order-1001" \
  -H "Content-Type: application/json" \
  -d '{ … }'
the same key, the same requestAnswered what the first was answered, with Idempotency-Replayed: true. Nothing is done twice.
the same key, another request422 idempotency.key_reused. A new request needs a new key.
while the first is still running409 idempotency.in_progress. Send it again in a moment.
the same key, and the first’s answer was not kept409 idempotency.answer_lost. The request was carried out; do not send it again.

A key is remembered for a day. A request that was refused is not remembered at all.

Events

What happens in a company — a document posted, a part changed, a product completed — is an event. It is thin on purpose: its type, what it is about, when. Read the rest with the key.

GET /events?after=4170

{
  "events": [
    {
      "id": 4171,
      "type": "document.posted",
      "at": "2026-10-03T11:35:03.412Z",
      "subject": {
        "kind": "document",
        "id": "0b6f6a53-3c1e-4d6e-9a43-6a5f0c1c2d3e",
        "number": "PR-2026-0042",
        "document_type": "receipt",
        "revision": 1
      }
    }
  ]
}

Keep the id of the last event you have seen and ask for what came after it: GET /events. Events are kept thirty days, and a key is told only the events of what its role may read.

document.posted .corrected .deletedA stock document: its id, number, type and revision.
part.created .changedA part, by its number.
build.completedA product, and the document that received it.
job.opened .changed .cancelledA build order, by its id and number.
order.opened .changed .cancelledA purchase order, by its number.

Webhooks

Instead of asking, be told. The owner adds a webhook in Settings → Users → API — an https address and, if not all of them, which events — and is shown its signing secret once. The address is then sent the same events as they happen, oldest first:

POST /your/endpoint
Content-Type: application/json
Manufik-Webhook: 5d1f0c5e-8a55-4c0e-9d0c-2f1f3b0a7c11
Manufik-Timestamp: 1791026103
Manufik-Signature: v1=6f0c…e41a

{ "events": [ { "id": 4171, "type": "document.posted", "at": "…", "subject": { … } } ] }

Check the signature

Every delivery is signed — HMAC-SHA256 with the webhook’s secret, over the timestamp, a dot and the raw body. Compute it yourself and compare; refuse a timestamp more than a few minutes old.

import hashlib, hmac, time

def genuine(secret: str, headers, body: bytes) -> bool:
    stamp = headers["Manufik-Timestamp"]
    if abs(time.time() - int(stamp)) > 300:
        return False
    want = "v1=" + hmac.new(
        secret.encode(), stamp.encode() + b"." + body, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(want, headers["Manufik-Signature"])

What to expect

  • Answer 2xx within five seconds. Do the work afterwards.
  • A delivery may arrive twice. One that failed is sent again with the next event, so keep the last event id and skip what is not newer.
  • Nothing is skipped. What an endpoint missed while it was down waits, in order. After ten failures in a row the webhook is stopped; the owner sends what waited with Send again.
  • A webhook is switched off when the owner who made it, or who last set its address or switched it on, stops being an owner. Its address may be their own server; an owner switches it on again if the address is the company’s.
  • The feed is the record. If in doubt, ask GET /events.
  • The owner’s Test is one event of type ping. Its id is 0, it is signed like any other, and it is not in the feed.

Versioning

This is version 1. Operations, fields and event types are added; none is removed or changes its meaning within a version — so ignore fields you do not know. The whole of it as an OpenAPI document, for a client generator: v1.json.

Its corrections. 11 October 2026: POST /documents no longer takes the types build and stocktake. Completing a product and posting a stock count write those documents. 24 October 2026: a receipt’s charge takes a kind from its list only — freight, duty, import VAT, handling, insurance, packaging, commission, rounding. Interest or a penalty capitalised as a charge is not part of acquisition cost. And an opening not in the company’s books, dated after the first day of its accounting period, is asked about (opening.mid_period) until it is sent with confirm. 5 November 2026: a new receipt is posted by POST /receipts, which keeps its vendor, tax point, tax and invoice — a gift or a sample too, with its reason; POST /documents answers type: receipt with 422 receipt.own_form.

Reference

Parts and stock

The catalogue, and what is on the shelf: quantities, cost and where.

Parts and what is on hand

GET/api/v1/parts

Example request
curl https://manufik.eu/api/v1/parts \
  -H "Authorization: Bearer mfk_…"

Answer 200

43 fields
partsrequiredobject[]
parts[].averagerequiredstringWeighted average unit cost. Empty, like value, for a reader who may not read money.
parts[].binsrequiredintegerHow many bins hold a non-zero quantity of it, available or not.
parts[].classrequiredstringmaterialgoodssemiproduct
parts[].compositionrequiredstring
parts[].customer_ownedrequiredboolean
parts[].descriptionrequiredstring
parts[].for_customerrequiredbooleanMade from a customer's material for that customer, and the customer's: a service, whose value added is work in progress until it is handed over. Semi-finished and finished products only; settled at the first movement.
parts[].freerequiredstring
parts[].heldrequiredstring
parts[].in_bomrequiredbooleanWhether a bill of materials has it as a component.
parts[].kindrequiredstringThe code of one of the company's kinds of part: electronic, other, or one it made.
parts[].labour_rate_per_hourrequiredstring
parts[].linksrequiredobject[]
parts[].links[].namerequiredstring
parts[].links[].skurequiredstring
parts[].links[].urlrequiredstring
parts[].links[].vendorrequiredstring
parts[].machine_rate_per_hourrequiredstring
parts[].maderequiredboolean
parts[].movedrequiredboolean
parts[].on_handrequiredstringBase units. A string, because a decimal that goes through a float is not the same decimal.
parts[].orderedrequiredstring
parts[].overhead_pct_on_materialrequiredstring
parts[].pnrequiredstring
parts[].serializedrequiredboolean
parts[].tagsrequiredstring[]
parts[].unitrequiredstring
parts[].valuerequiredstringWhat the stock on hand is worth, in the company's currency. Empty for a reader whose role reads neither the parts nor the reports.
parts[].vendorsrequiredinteger
parts[].attrsobject
parts[].binstringThe bin holding it, when there is exactly one. Empty when it is nowhere or in several.
parts[].customerstringWhose it is: the customer's code.
parts[].eanstring
parts[].last_locationstringWhen no bin holds any of it: the bin it last left, if goods may be put there. Empty otherwise.
parts[].min_stockstringWhat the free stock should not fall below.
parts[].off_balance_valuestringWhat one unit of a customer's material is worth in the off-balance-sheet records, as the customer's contract or delivery note gives it. Absent when nobody said, and on the company's own parts.
parts[].order_up_tostringHow far an order should bring it.
parts[].reorder_pointstringWhen to order, typed over the computed one.
parts[].sale_pricestring
parts[].serial_maskstringWarns; never refuses.
parts[].sole_locationstringThe one bin this part's stock is in, when it is in exactly one. Empty otherwise.
parts[].urlstring

Refusals401403404409422429

Add a part

POST/api/v1/parts

Example request
curl -X POST https://manufik.eu/api/v1/parts \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "pn": "RES-0603-F-10K",
    "unit": "pcs"
  }'

Parameters

Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

pnrequiredstringWritten by a person, and one character of it a letter or a digit. No slash: see docs/part-numbers.md.
unitrequiredstringA base unit from the controlled list.
attrsobjectWhat the number was suggested from. Never parsed back out of the number.
classstringmaterial and goods are bought, semi and product are made here. Must agree with made when both are sent.materialgoodssemiproduct
compositionstringWhether it is made of other parts. Defaults to none: bought, or otherwise not built from anything.nonecomposed
customerstringWhose it is, by customer code. Optional.
customer_ownedbooleanMaterial a customer supplied: counted and consumed, never valued or posted. Bought classes only; settled at the first movement.
descriptionstringOptional. A part number that already says what the thing is does not need a sentence repeating it.
eanstringThe manufacturer's EAN or UPC, check digit and all. Unique in the company.
for_customerbooleanMade from a customer's material for that customer, and the customer's: a service, whose value added is work in progress until it is handed over. Semi-finished and finished products only; settled at the first movement.
kindstringThe code of one of the company's kinds of part. Defaults to electronic. attrs keeps only the fields that kind has.
labour_rate_per_hourstringRead only for a part made here.
machine_rate_per_hourstringRead only for a part made here. Empty takes the company's own rate for a made class.
madebooleanBuilt here rather than bought. Without a class: a product (123) when made, material (112) when bought.
min_stockstringWhat the free stock should not fall below. Absent keeps it, empty clears it.
off_balance_valuestringWhat one unit of a customer's material is worth in the off-balance-sheet records, as the customer's contract or delivery note gives it. Optional; ignored on the company's own part. Never in the average, a lot or the posting proposal.
order_up_tostringHow far an order should bring it; empty is up to the reorder point.
overhead_pct_on_materialstringAs a fraction: 0.15 is fifteen per cent. Read only for a part made here.
reorder_pointstringWhen to order it, typed; empty lets Manufik work it out from the minimum, the consumption and the lead time.
sale_pricestringWhat one is sold for, in the company's currency and net of its own VAT. Optional; posted nowhere.
serial_maskstringOptional, and it only warns: when a particular piece carries a different format, the system has no business arguing.
serializedboolean
tagsstring[]
urlstringA datasheet, the manufacturer's page, a drawing. Opened in a new tab; never fetched.
vendorsobject[]
vendors[].skurequiredstring
vendors[].vendorrequiredstringVendor code.
vendors[].barcodestringThe number on their label when it is not their SKU. Omit to leave it alone; send "" to clear it.
vendors[].mpnstringThe manufacturer's own number, when the vendor's line carries one. Omit to leave it alone; send "" to clear it.
vendors[].pack_labelstringWhat one pack is called. Omit to leave it alone; send "" to clear it.
vendors[].pack_sizestringOmit to leave it alone. Blank is the default of one.
vendors[].urlstringTheir page for this part. Omit to leave it alone; send "" to clear it.

Answer 201

42 fields
averagerequiredstringWeighted average unit cost. Empty, like value, for a reader who may not read money.
binsrequiredintegerHow many bins hold a non-zero quantity of it, available or not.
classrequiredstringmaterialgoodssemiproduct
compositionrequiredstring
customer_ownedrequiredboolean
descriptionrequiredstring
for_customerrequiredbooleanMade from a customer's material for that customer, and the customer's: a service, whose value added is work in progress until it is handed over. Semi-finished and finished products only; settled at the first movement.
freerequiredstring
heldrequiredstring
in_bomrequiredbooleanWhether a bill of materials has it as a component.
kindrequiredstringThe code of one of the company's kinds of part: electronic, other, or one it made.
labour_rate_per_hourrequiredstring
linksrequiredobject[]
links[].namerequiredstring
links[].skurequiredstring
links[].urlrequiredstring
links[].vendorrequiredstring
machine_rate_per_hourrequiredstring
maderequiredboolean
movedrequiredboolean
on_handrequiredstringBase units. A string, because a decimal that goes through a float is not the same decimal.
orderedrequiredstring
overhead_pct_on_materialrequiredstring
pnrequiredstring
serializedrequiredboolean
tagsrequiredstring[]
unitrequiredstring
valuerequiredstringWhat the stock on hand is worth, in the company's currency. Empty for a reader whose role reads neither the parts nor the reports.
vendorsrequiredinteger
attrsobject
binstringThe bin holding it, when there is exactly one. Empty when it is nowhere or in several.
customerstringWhose it is: the customer's code.
eanstring
last_locationstringWhen no bin holds any of it: the bin it last left, if goods may be put there. Empty otherwise.
min_stockstringWhat the free stock should not fall below.
off_balance_valuestringWhat one unit of a customer's material is worth in the off-balance-sheet records, as the customer's contract or delivery note gives it. Absent when nobody said, and on the company's own parts.
order_up_tostringHow far an order should bring it.
reorder_pointstringWhen to order, typed over the computed one.
sale_pricestring
serial_maskstringWarns; never refuses.
sole_locationstringThe one bin this part's stock is in, when it is in exactly one. Empty otherwise.
urlstring

Refusals401403404409422429

Correct a part

PATCH/api/v1/parts/{pn}

The number never changes. What else may change depends on whether anything has moved: before the first movement everything can; after it the unit, whether it is tracked by serial number, its class of stock and whether the customer owns it are fixed, and everything else may still change. A field left out is left as it is; a field sent empty is cleared.

Example request
curl -X PATCH https://manufik.eu/api/v1/parts/{pn} \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "attrs": "string"
  }'

Parameters

pnrequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

attrsobjectThe fields the part's kind describes it by. Replaced wholesale when sent; absent keeps them, unless the kind changes.
classstringAbsent keeps the class when it agrees with made. Changes only before the first movement.materialgoodssemiproduct
compositionstringAbsent keeps it.nonecomposed
customerstringWhose it is, by customer code. Absent keeps it; empty clears it.
customer_ownedbooleanAbsent keeps it. Changes only before the first movement.
descriptionstringAbsent keeps it; empty clears it.
eanstringChangeable at any time: it describes the box, not the ledger. Absent keeps it; empty clears it.
for_customerbooleanMade from a customer's material for that customer, and the customer's. Absent keeps it. Semi-finished and finished products only; changes only before the first movement.
kindstringChangeable at any time: it describes the part and moves nothing. The fields of the old kind are dropped. Absent keeps it.
labour_rate_per_hourstringTimes the revision's labour minutes. Zero means no labour cost at all. Whether it is capitalised is asked on the completion form, not here. Absent keeps it; empty is zero.
machine_rate_per_hourstringTimes the revision's machine minutes. Never capitalised: machine time is in the management figure alone. Absent keeps it; empty is zero.
madebooleanAbsent keeps where the part comes from.
method_reasonstringWhy the overhead or the labour rate changes. Kept in the record of methods.
min_stockstringWhat the free stock should not fall below. Absent keeps it, empty clears it.
off_balance_valuestringWhat one unit of a customer's material is worth in the off-balance-sheet records. Changeable at any time: nothing in the ledger reads it. Absent keeps it; empty clears it; ignored, and cleared, on the company's own part.
order_up_tostringHow far an order should bring it; empty is up to the reorder point.
overhead_pct_on_materialstringSolder, flux, cleaner, electricity, a worn nozzle — as a fraction of this part's own material. 0.08 is eight per cent. Absent keeps it; empty is zero.
reorder_pointstringWhen to order it, typed; empty lets Manufik work it out from the minimum, the consumption and the lead time.
sale_pricestringWhat one is sold for, net of the company's own VAT. Changeable at any time: it is read beside the calculation price and posted nowhere. Absent keeps it; empty clears it.
serial_maskstringAbsent keeps it; empty clears it.
serializedbooleanAbsent keeps it. Changes only before the first movement.
tagsstring[]Replaced wholesale when sent: what is sent is what the part has afterwards. Absent keeps them.
unitstringAbsent keeps it. Changes only before the first movement.
urlstringAbsent keeps it; empty clears it.

Answer 204no body

Refusals401403404409422429

Read one bill of materials

GET/api/v1/parts/{pn}/bom

The revision's lines, what each component costs and whether it is itself made, plus every revision of the part.

Example request
curl https://manufik.eu/api/v1/parts/{pn}/bom \
  -H "Authorization: Bearer mfk_…"

Parameters

pnrequiredpath · string
revquery · stringWhich revision. Empty means the released one, or the newest draft if none is released.

Answer 200

38 fields
descriptionrequiredstring
linesrequiredobject[]
lines[].averagerequiredstringWhat one of this component costs: the weighted average of what it holds, and for a part that holds nothing the average its last pieces left at. Zero for a part that never had a price.
lines[].binsrequiredstring[]Every bin holding a non-zero quantity of this component, in code order.
lines[].composedrequiredbooleanThis component is made of other parts, so it has a bill of materials of its own.
lines[].descriptionrequiredstring
lines[].designatorsrequiredstring[]As drawn. When a line is wrong the question is always which one on the board.
lines[].dnprequiredbooleanOn the board, deliberately unfitted. It belongs on the bill of materials and must not be consumed.
lines[].exclude_from_bomrequiredboolean
lines[].line_costrequiredstring
lines[].line_norequiredinteger
lines[].on_handrequiredstring
lines[].orderedrequiredstring
lines[].pnrequiredstring
lines[].qtyrequiredstring
lines[].sourcerequiredstringkicad or manual. An import replaces only the lines it wrote.
lines[].unitrequiredstring
lines[].unit_costrequiredstring
lines[].min_stockstringThe component's minimum stock; empty is none.
lines[].mpnstringThe manufacturer's own number, from the first vendor line that carries one.
lines[].notestring
lines[].source_footprintstring
lines[].source_valuestring
lines[].vendor_descriptionstringWhat a vendor calls it, for a part whose own description is empty.
pnrequiredstring
revrequiredstring
revisionsrequiredobject[]
revisions[].created_atrequiredstring
revisions[].labour_minutesrequiredstring
revisions[].linesrequiredinteger
revisions[].machine_minutesrequiredstring
revisions[].revrequiredstring
revisions[].statusrequiredstring
revisions[].notestringWhat the bench should know that the lines do not say: several lines, shown on the assembly list.
revisions[].released_atstring
statusrequiredstring
unitrequiredstring
notestringThe note of the revision shown.

Refusals401403404409422429

The arrivals the average is made of

GET/api/v1/parts/{pn}/cost

Example request
curl https://manufik.eu/api/v1/parts/{pn}/cost \
  -H "Authorization: Bearer mfk_…"

Parameters

pnrequiredpath · string

Answer 200

14 fields
averagerequiredstringThe part's weighted average as the parts list shows it: after its last movement of any kind, zero when it holds nothing.
linesrequiredobject[]
lines[].average_afterrequiredstringThe weighted average as it stood after this movement.
lines[].daterequiredstring
lines[].documentrequiredstring
lines[].document_norequiredstring
lines[].kindrequiredstring
lines[].qtyrequiredstring
lines[].qty_afterrequiredstringWhat was on hand after this movement. Issues between two arrivals lower it, and the next arrival is averaged with what was left.
lines[].total_costrequiredstringWhat the movement added to the part's value — a revaluation's or a price adjustment's whole effect, since it moves no quantity.
lines[].unit_costrequiredstringWhat one unit cost on this arrival.
lines[].vendorstringWhose receipt it was: a price adjustment's is the receipt's it adjusts.
pnrequiredstring
unitrequiredstring

Refusals401403404409422429

One piece, and everywhere it has been — its number in the query

GET/api/v1/parts/{pn}/serial

As get-serial, for any number: one with a slash in it cannot be a path segment.

Example request
curl https://manufik.eu/api/v1/parts/{pn}/serial \
  -H "Authorization: Bearer mfk_…"

Parameters

pnrequiredpath · string
serialrequiredquery · stringThe piece's number, as on its label.

Answer 200

14 fields
descriptionrequiredstring
movementsrequiredobject[]Every time this piece moved, oldest first.
movements[].accounting_daterequiredstring
movements[].document_idrequiredstring
movements[].document_norequiredstring
movements[].kindrequiredstring
movements[].locationrequiredstring
movements[].qtyrequiredstring
movements[].typerequiredstring
movements[].reasonstring
on_handrequiredboolean
pnrequiredstring
serialrequiredstring
locationstring

Refusals401403404409422429

One piece, and everywhere it has been

GET/api/v1/parts/{pn}/serials/{serial}

Addressed by part and number together, because the number alone does not identify a piece. A number with a slash in it cannot be a path segment: get-serial-by-query takes it in the query.

Example request
curl https://manufik.eu/api/v1/parts/{pn}/serials/{serial} \
  -H "Authorization: Bearer mfk_…"

Parameters

pnrequiredpath · string
serialrequiredpath · string

Answer 200

14 fields
descriptionrequiredstring
movementsrequiredobject[]Every time this piece moved, oldest first.
movements[].accounting_daterequiredstring
movements[].document_idrequiredstring
movements[].document_norequiredstring
movements[].kindrequiredstring
movements[].locationrequiredstring
movements[].qtyrequiredstring
movements[].typerequiredstring
movements[].reasonstring
on_handrequiredboolean
pnrequiredstring
serialrequiredstring
locationstring

Refusals401403404409422429

Which bins hold one part, and how many

GET/api/v1/parts/{pn}/stock

Example request
curl https://manufik.eu/api/v1/parts/{pn}/stock \
  -H "Authorization: Bearer mfk_…"

Parameters

pnrequiredpath · string

Answer 200

8 fields
locationsrequiredobject[]Bins holding a non-zero quantity of it, by code.
locations[].availablerequiredboolean
locations[].coderequiredstring
locations[].qtyrequiredstring
locations[].reachablerequiredbooleanavailable, and so is every warehouse above it
locations[].warehouserequiredstring
locations[].warehouse_pathrequiredstring
pnrequiredstring

Refusals401403404409422429

Who sells one part, and what they call it

GET/api/v1/parts/{pn}/vendors

The other way round from get-vendor.

Example request
curl https://manufik.eu/api/v1/parts/{pn}/vendors \
  -H "Authorization: Bearer mfk_…"

Parameters

pnrequiredpath · string

Answer 200

9 fields
vendorsrequiredobject[]
vendors[].namerequiredstring
vendors[].pack_sizerequiredstring
vendors[].skurequiredstring
vendors[].vendorrequiredstring
vendors[].barcodestring
vendors[].mpnstring
vendors[].pack_labelstring
vendors[].urlstring

Refusals401403404409422429

Serial numbers

Pieces tracked one by one.

Find a serial number

GET/api/v1/serials

A number may belong to more than one part — a product and the board inside it commonly share one — so every row names its part.

Example request
curl https://manufik.eu/api/v1/serials \
  -H "Authorization: Bearer mfk_…"

Parameters

qquery · stringPart of a serial number. Empty lists everything.
pnquery · stringOnly this part.
on_handquery · booleanOnly pieces currently on the shelf.
stockedquery · stringyes: only on the shelf; no: only pieces that have left. Empty is either.
classquery · stringOnly pieces of parts of this class of stock.
composedquery · stringyes: only parts made of other parts; no: only the rest.
afterquery · stringThe next of the previous block. Empty is the first block, which also carries the total.
limitquery · integer

Answer 200

14 fields
serialsrequiredobject[]
serials[].classrequiredstringmaterialgoodssemiproduct
serials[].compositionrequiredstringnonecomposed
serials[].descriptionrequiredstring
serials[].first_seenrequiredstring
serials[].last_movedrequiredstring
serials[].on_handrequiredbooleanDerived from the movements, never stored.
serials[].pnrequiredstring
serials[].serialrequiredstring
serials[].last_reasonstringWhy it moved last — the reason of the document, where there was one.
serials[].locationstringWhere it was last put. Absent once it has left.
totalrequiredintegerPieces the filter matches. On the first block only.
truncatedrequiredbooleanThere are more: ask again with after set to next.
nextstringWhere this block ended. Absent on the last one.

Refusals401403404409422429

Warehouses

Where stock is kept, as a tree.

The warehouse tree

GET/api/v1/warehouses

Depth-first from each root, which is the order a tree is read in.

Example request
curl https://manufik.eu/api/v1/warehouses \
  -H "Authorization: Bearer mfk_…"

Answer 200

27 fields
warehousesrequiredobject[]
warehouses[].availablerequiredboolean
warehouses[].binsrequiredintegerBins directly in this warehouse, not counting those in the ones inside it.
warehouses[].childrenrequiredinteger
warehouses[].coderequiredstring
warehouses[].depthrequiredinteger1 for a top-level warehouse.
warehouses[].namerequiredstring
warehouses[].pathrequiredstringNames from the top down, for display: 'Cabinet / Box C'.
warehouses[].reachablerequiredbooleanavailable, and so is everything above it
warehouses[].writablerequiredbooleanThe reader's role may change this warehouse and post stock in it.
warehouses[].held_atstringThe code of the nearest warehouse up the tree, itself included, that a third party holds.
warehouses[].held_bystringWho holds that one.
warehouses[].holderobjectA third party holds this warehouse: an assembly house, a store, a consignee.
warehouses[].holder.accountsrequiredobjectThe analytic accounts of its stock, per class.
warehouses[].holder.accounts.goodsrequiredstring
warehouses[].holder.accounts.materialrequiredstringEmpty: the class's own account.
warehouses[].holder.accounts.productrequiredstring
warehouses[].holder.accounts.semirequiredstring
warehouses[].holder.accounts.wiprequiredstringWork in progress whose work is here: 121.9xx. Empty: the company's own.
warehouses[].holder.kindrequiredstringvendorcustomerother
warehouses[].holder.namerequiredstringWho: the partner's name, or the one typed.
warehouses[].holder.customerstringThe customer's code, while there is one.
warehouses[].holder.forstringprocessingstorageconsignment
warehouses[].holder.vendorstringThe vendor's code, while there is one.
warehouses[].parentstringCode of the warehouse this one is inside.
warehouses[].responsiblestringWho answers for its stock: its own responsible_person, or that of the nearest warehouse above it that names one. Empty: nobody named — the company as one.
warehouses[].responsible_personstringThe hmotně odpovědná osoba named on this warehouse. Empty: none named here.

Refusals401403404409422429

Bins

The shelf a document line names.

List bins

GET/api/v1/locations

Ordered by warehouse path and then by code, which is the order they are walked in.

Example request
curl https://manufik.eu/api/v1/locations \
  -H "Authorization: Bearer mfk_…"

Answer 200

11 fields
locationsrequiredobject[]
locations[].availablerequiredboolean
locations[].coderequiredstring
locations[].partsrequiredintegerHow many parts lie here now: those whose quantity at this bin is not zero.
locations[].reachablerequiredboolean
locations[].usedrequiredbooleanWhether any movement names this bin, on any document or revision; a bin that is used cannot be removed, empty or not.
locations[].warehouserequiredstring
locations[].warehouse_namerequiredstring
locations[].warehouse_pathrequiredstring
locations[].writablerequiredboolean
locations[].held_statestringThe EU member state of the vendor or customer holding this bin's warehouse — its country, else the prefix of its VAT ID. Absent for a bin the company holds itself, one a named person holds, and one held outside the Union.

Refusals401403404409422429

What is in one bin

GET/api/v1/locations/{code}

Example request
curl https://manufik.eu/api/v1/locations/{code} \
  -H "Authorization: Bearer mfk_…"

Parameters

coderequiredpath · string

Answer 200

11 fields
availablerequiredboolean
coderequiredstring
linesrequiredobject[]Parts with a non-zero quantity here.
lines[].averagerequiredstringThe part's average, not this bin's: value does not live at a location.
lines[].descriptionrequiredstring
lines[].pnrequiredstring
lines[].qtyrequiredstring
lines[].unitrequiredstring
reachablerequiredbooleanavailable, and so is every warehouse above it
warehouserequiredstring
warehouse_pathrequiredstring

Refusals401403404409422429

Stock documents

Opening balances, issues, transfers, scrap, revaluations and returns. A posted document is a fact: it is corrected by a person, not by a program.

List documents

GET/api/v1/documents

Newest first, by accounting date and then by the sequence they were posted in. In blocks: pass the previous block's next as after.

Example request
curl https://manufik.eu/api/v1/documents \
  -H "Authorization: Bearer mfk_…"

Parameters

typequery · stringComma-separated document types. Empty means every type.
fromquery · string · dateAccounting date, inclusive.
toquery · string · dateAccounting date, inclusive.
pnquery · stringOnly documents touching this part.
supersededquery · booleanInclude revisions that a later one replaced. Off by default: they are history, not entries.
waitingquery · booleanOnly the receipts still waiting for their invoice, or with a charge still an estimate, as of the company's today — what the overview's tile counts. No drafts.
afterquery · stringThe next of the previous block. Empty is the first block, which also carries the drafts and the total.
limitquery · integer

Answer 200

38 fields
documentsrequiredobject[]
documents[].accounting_daterequiredstring
documents[].document_norequiredstring
documents[].draftrequiredboolean
documents[].idrequiredstring
documents[].linesrequiredintegerThe lines the document was written with: a receipt's invoice lines, consumables included, and a transfer's lines once — not its two movements each.
documents[].occurred_atrequiredstring
documents[].placementrequiredintegerWhere the document stands on its day. Two documents of the same accounting date are read, and listed, in this order.
documents[].producedrequiredbooleanWritten by a build or a stock count rather than by a person; corrected at its source and never deleted.
documents[].recorded_atrequiredstring
documents[].revisionrequiredinteger1 for an original, 2 for its first correction, and so on.
documents[].supersededrequiredbooleanA later revision replaced this one. It stays in the ledger and does not replay.
documents[].typerequiredstring
documents[].valuerequiredstringWhat the document did to the value of stock, at cost. Signed, so a column of these sums.
documents[].accounting_nostring
documents[].actorstring
documents[].deleted_atstringWhen it was taken out of the books. It still exists and still holds its number; it no longer replays.
documents[].duzpstring
documents[].from_locationstring
documents[].held_bystringThe number of the delivery note, not cancelled, issued from this goods issue. While it stands, the goods issue can be neither corrected nor deleted.
documents[].purchase_orderstring
documents[].reasonstring
documents[].referencestring
documents[].screenstringdocumentreceipt
documents[].seriesstringThe number series a goods issue was numbered from where its company numbers one leaving it apart — issue_external (WZ) or issue (RW) in Poland. Absent elsewhere, on every other type and on an issue posted before the series existed.
documents[].supplier_doc_nostring
documents[].to_locationstring
documents[].vatstringA receipt's tax, on its lines and its charges, in the company's currency.
documents[].vendorstring
documents[].vendor_removedboolean
documents[].without_invoicebooleanA receipt still waiting for its invoice: neither a correction nor a price adjustment in force has entered it.
draftsrequiredintegerHow many of them are still being typed.
totalrequiredintegerPosted documents the filter matches, drafts aside. On the first block only; later ones repeat nothing.
truncatedrequiredbooleanThere are more: ask again with after set to next.
nextstringWhere this block ended. Absent on the last one.
value_rounded_totalstringSum of value over the same documents with each rounded to two places first: what the rows add up to as printed. value_total rounded to two places, less this, is the rounding difference. First block only.
value_totalstringSum of value over every document the filter matches. First block only.
vat_totalstringSum of the VAT on the receipts in force the filter matches, in the company's currency: a superseded or deleted revision's is not in it, as its value is not in value_total. First block only.

Refusals401403404409422429

Post a document

POST/api/v1/documents

A posted document is final for a program: it is corrected in the application, by a new revision under the same number — never by posting a second document, which would count twice.

Example request
curl -X POST https://manufik.eu/api/v1/documents \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "opening",
    "accounting_date": "2026-01-31",
    "lines": [
      {
        "pn": "RES-0603-F-10K",
        "location": "A-01-1",
        "kind": "opening",
        "qty": "100"
      }
    ]
  }'

Parameters

Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

accounting_daterequiredstring · dateWhich period it belongs to.
linesrequiredobject[]At most 1000, but on an opening, which is a company's whole stock: more is refused as 422 document.too_many_lines.
lines[].kindrequiredstringopeningreceiptissueoutputadjustmentscrapreturn_vendortransfer_intransfer_outrevaluationreturn_productionreturn_customer
lines[].locationrequiredstringBin code within the company.
lines[].pnrequiredstringThe part's number.
lines[].qtyrequiredstringSigned, in the part's base unit. A string, not a number.
lines[].duzpstringThe date that tax belongs to, YYYY-MM-DD. Required with vat_amount.
lines[].ordinalintegerThe line's number on the document, which a return names it by. A correction sends each line's own, so a removed line above does not renumber the rest. Absent: the next number after the highest stated, or the line's position when no line states one. Two lines with one number are refused: document.duplicate_line.
lines[].serialstring
lines[].sourceobject
lines[].source.document_norequiredstringThe document's number, e.g. PR-2026-0007.
lines[].source.linerequiredintegerThe line: a receipt's line number, or the ordinal on the document.
lines[].valuestringStated value, where the kind takes one. Absent is not zero: zero is what an invoice from a supplier not VAT registered says.
lines[].vat_amountstringVAT paid on this opening line, for § 79 ZDPH. Only on an opening line. On a correction, absent carries the tax of the line it replaces, for the quantity the line now holds; "0" says the line carries none.
typerequiredstringThe kind of document. Completing a product and posting a stock count write their own documents; neither is posted here. Nor is a new receipt, which post-receipt posts with its vendor, DUZP, tax and invoice — a gift or a sample too, with its reason (422 receipt.own_form); receipt is here for the preview of a correction of a receipt posted before it had a form of its own.openingreceiptissuetransferscraprevaluationreturn_vendorreturn_productionreturn_customer
confirmbooleanGo ahead even though this moves figures already reported, or is dated ahead — or, on an opening not in the company's books, is dated after the first day of its accounting period (opening.mid_period).
deliveryobjectWho an issue went to: the customer, copied as they are today, their order number and the build order. Only on an issue.
delivery.customerrequiredstringCustomer code. Their name, Company ID, VAT ID and address are copied onto the goods issue as they are today. On a correction, the customer of the revision corrected keeps the copy made then; empty means the goods issue went to nobody.
delivery.customer_refstringTheir number for what they ordered.
delivery.jobstringThe build order it was issued from, by number.
delivery.notestring
disposalobjectThe disposal record of a scrap: required when the reason's chart row requires one, frozen once posted.
disposal.disposed_atrequiredstring · date-timeWhen.
disposal.methodrequiredstringHow it was disposed of.
disposal.outcomerequiredstringWhat became of the items. The law asks for this as well as the method.
disposal.placerequiredstringWhere.
disposal.reasonrequiredstringWhy the stock was disposed of.
disposal.responsiblerequiredstringWho was responsible — people, not users: they may have no account here.
disposal.damagebooleanDisposed of because it was damaged or destroyed. Then it is damage — deductible up to its compensation, or in full on the police's or a disaster's document — rather than a disposal of stock nobody needs, whatever the reason.
disposal.notestring
occurred_atstring · date-timeWhen it physically happened. Defaults to now — the moment it is posted; a correction keeps the time of the revision it corrects.
openingobjectWhether this opening balance is already in the company's books. Only on an opening; absent is a document the posting proposal offers.
opening.already_in_booksrequiredbooleanThe stock is already in the company's books, so the posting proposal leaves the document out. The movements and their value are the same either way.
positionstringWhere this goes among the documents already on its day. Asked with a 409 document.position when it matters; after them when not given.beforeafter
reasonstringRequired on scrap and stocktake: it decides the account, and therefore the tax treatment.
referencestring

Answer 201

4 fields
document_norequiredstring
idrequiredstring
revisionrequiredinteger
attachedstring

Refusals401403404409422429

What this document would be worth, without posting it

POST/api/v1/documents/preview

The same calculation the posting runs, over the draft's own lines, against what the parts held at the end of the accounting date given. Nothing is written and nothing is numbered. An `output` takes its value from the issues sharing the document.

Example request
curl -X POST https://manufik.eu/api/v1/documents/preview \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "opening",
    "accounting_date": "2026-01-31",
    "lines": [
      {
        "pn": "RES-0603-F-10K",
        "location": "A-01-1",
        "kind": "opening",
        "qty": "100"
      }
    ]
  }'

Parameters

correctsquery · stringThe revision a correction would replace, by id: it is previewed as though that revision had not taken or given anything. Absent for a new document.

Request body

accounting_daterequiredstring · dateWhich period it belongs to.
linesrequiredobject[]At most 1000, but on an opening, which is a company's whole stock: more is refused as 422 document.too_many_lines.
lines[].kindrequiredstringopeningreceiptissueoutputadjustmentscrapreturn_vendortransfer_intransfer_outrevaluationreturn_productionreturn_customer
lines[].locationrequiredstringBin code within the company.
lines[].pnrequiredstringThe part's number.
lines[].qtyrequiredstringSigned, in the part's base unit. A string, not a number.
lines[].duzpstringThe date that tax belongs to, YYYY-MM-DD. Required with vat_amount.
lines[].ordinalintegerThe line's number on the document, which a return names it by. A correction sends each line's own, so a removed line above does not renumber the rest. Absent: the next number after the highest stated, or the line's position when no line states one. Two lines with one number are refused: document.duplicate_line.
lines[].serialstring
lines[].sourceobject
lines[].source.document_norequiredstringThe document's number, e.g. PR-2026-0007.
lines[].source.linerequiredintegerThe line: a receipt's line number, or the ordinal on the document.
lines[].valuestringStated value, where the kind takes one. Absent is not zero: zero is what an invoice from a supplier not VAT registered says.
lines[].vat_amountstringVAT paid on this opening line, for § 79 ZDPH. Only on an opening line. On a correction, absent carries the tax of the line it replaces, for the quantity the line now holds; "0" says the line carries none.
typerequiredstringThe kind of document. Completing a product and posting a stock count write their own documents; neither is posted here. Nor is a new receipt, which post-receipt posts with its vendor, DUZP, tax and invoice — a gift or a sample too, with its reason (422 receipt.own_form); receipt is here for the preview of a correction of a receipt posted before it had a form of its own.openingreceiptissuetransferscraprevaluationreturn_vendorreturn_productionreturn_customer
confirmbooleanGo ahead even though this moves figures already reported, or is dated ahead — or, on an opening not in the company's books, is dated after the first day of its accounting period (opening.mid_period).
deliveryobjectWho an issue went to: the customer, copied as they are today, their order number and the build order. Only on an issue.
delivery.customerrequiredstringCustomer code. Their name, Company ID, VAT ID and address are copied onto the goods issue as they are today. On a correction, the customer of the revision corrected keeps the copy made then; empty means the goods issue went to nobody.
delivery.customer_refstringTheir number for what they ordered.
delivery.jobstringThe build order it was issued from, by number.
delivery.notestring
disposalobjectThe disposal record of a scrap: required when the reason's chart row requires one, frozen once posted.
disposal.disposed_atrequiredstring · date-timeWhen.
disposal.methodrequiredstringHow it was disposed of.
disposal.outcomerequiredstringWhat became of the items. The law asks for this as well as the method.
disposal.placerequiredstringWhere.
disposal.reasonrequiredstringWhy the stock was disposed of.
disposal.responsiblerequiredstringWho was responsible — people, not users: they may have no account here.
disposal.damagebooleanDisposed of because it was damaged or destroyed. Then it is damage — deductible up to its compensation, or in full on the police's or a disaster's document — rather than a disposal of stock nobody needs, whatever the reason.
disposal.notestring
occurred_atstring · date-timeWhen it physically happened. Defaults to now — the moment it is posted; a correction keeps the time of the revision it corrects.
openingobjectWhether this opening balance is already in the company's books. Only on an opening; absent is a document the posting proposal offers.
opening.already_in_booksrequiredbooleanThe stock is already in the company's books, so the posting proposal leaves the document out. The movements and their value are the same either way.
positionstringWhere this goes among the documents already on its day. Asked with a 409 document.position when it matters; after them when not given.beforeafter
reasonstringRequired on scrap and stocktake: it decides the account, and therefore the tax treatment.
referencestring

Answer 200

5 fields
linesrequiredobject[]
lines[].basisrequiredstringThe costing behaviour that values this line: in_declared, in_at_average, in_computed, out_at_average, out_declared, revalue, skip, in_at_source or adjust_price.
lines[].ordinalrequiredinteger
lines[].valuestring
valuerequiredstringWhat the document would do to the value of stock, at cost. Signed, so a transformation of one part into another comes back at about nothing.

Refusals401403404409422429

Read one document

GET/api/v1/documents/{id}

Header, lines with the cost each came to, and every revision under the same number.

Example request
curl https://manufik.eu/api/v1/documents/{id} \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid

Answer 200

65 fields
accounting_daterequiredstring
document_norequiredstring
idrequiredstring
linesrequiredobject[]
lines[].descriptionrequiredstring
lines[].kindrequiredstring
lines[].locationrequiredstring
lines[].ordinalrequiredinteger
lines[].pnrequiredstring
lines[].qtyrequiredstring
lines[].unitrequiredstring
lines[].avg_afterstring
lines[].consumed_valuestring
lines[].declared_valuestringWhat the document stated. Absent is not zero.
lines[].duzpstring
lines[].original_valuestring
lines[].qty_afterstring
lines[].serialstring
lines[].source_document_idstring
lines[].source_document_nostring
lines[].source_lineinteger
lines[].total_coststringSigned, like the document's own value.
lines[].unit_coststringPer unit, never negative: direction is in the quantity.
lines[].value_afterstring
lines[].vat_amountstring
occurred_atrequiredstring
placementrequiredintegerWhere the document stands on its day. Two documents of the same accounting date are read, and listed, in this order.
producedrequiredbooleanWritten by a build or a stock count rather than by a person; corrected at its source and never deleted.
recorded_atrequiredstring
revisionrequiredinteger
revisionsrequiredobject[]Every revision under this number, oldest first.
revisions[].currentrequiredboolean
revisions[].idrequiredstring
revisions[].recorded_atrequiredstring
revisions[].revisionrequiredinteger
supersededrequiredboolean
typerequiredstring
valuerequiredstring
actorstring
consumption_nostringThe number from the issue series a build's consumption was given when it was posted — Poland's RW beside the build's PW. Absent elsewhere, on every other type and on a build posted before migration 260.
delete_reasonstringWhy it was taken out of the books, as the person who did it said. Absent on a document deleted before the reason was asked.
deleted_atstringWhen it was taken out of the books. It still exists and still holds its number; it no longer replays.
deliveryobject
delivery.customerrequiredstringThe customer's code today; empty when it was never known, or on a superseded revision whose customer has since been removed — the copy beside it stays.
delivery.customer_namerequiredstring
delivery.notesrequiredobject[]
delivery.notes[].cancelledrequiredboolean
delivery.notes[].idrequiredstring
delivery.notes[].note_norequiredstring
delivery.customer_addressobject
delivery.customer_address.citystringTown, with the postal district where the post uses one ("Praha 1").
delivery.customer_address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
delivery.customer_address.streetstringStreet and number — the first line of the address.
delivery.customer_countrystringISO 3166 alpha-2, the customer's or else the company's, copied with the rest.
delivery.customer_icostring
delivery.customer_refstring
delivery.customer_vat_idstring
delivery.job_idstring
delivery.job_nostring
delivery.notestring
openingobject
opening.already_in_booksrequiredboolean
reasonstring
referencestring
seriesstringThe number series a goods issue was numbered from where its company numbers one leaving it apart — issue_external (WZ) or issue (RW) in Poland. Absent elsewhere, on every other type and on an issue posted before the series existed.

Refusals401403404409422429

Goods receipts

What arrived, with its landed cost.

Post a goods receipt

POST/api/v1/receipts

The one place a price enters the system. Charges are allocated across the lines by largest remainder, so the shares sum to the charge exactly.

Example request
curl -X POST https://manufik.eu/api/v1/receipts \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "accounting_date": "2026-01-31",
    "lines": [
      {
        "line_no": 1,
        "pn": "RES-0603-F-10K",
        "qty": "100",
        "unit_price": "12.50",
        "vat_amount": "12.50"
      }
    ]
  }'

Parameters

Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

accounting_daterequiredstring · date
linesrequiredobject[]At most 1000: more is refused as 422 document.too_many_lines.
lines[].line_norequiredintegerPosition on the invoice. It becomes the movement's ordinal, so a line that creates none leaves a gap.
lines[].pnrequiredstring
lines[].qtyrequiredstringBase units. A string, not a number.
lines[].unit_pricerequiredstringPer base unit, in the document's currency.
lines[].vat_amountrequiredstringRequired even while the company is not VAT registered. Zero is a value; a supplier not VAT registered charged none.
lines[].invoiced_qtystringWhat the paper said, if it was in packs.
lines[].line_totalstringWhat the invoice says the line comes to before VAT, in the document's currency, when it states a total rather than a unit price. It is what the line is costed at — quantity × a six-place unit price is a different amount once the quantity is large — and it must agree with qty × unit_price to the sixth place of the price.
lines[].locationstringThe bin it goes to. A line expensed on purchase (stocked: false) may leave it out: it goes to no shelf.
lines[].pack_sizestring
lines[].serialstringThe piece's number, for a part tracked by serial number. Such a line is one piece.
lines[].stockedbooleanDefault true. False expenses it on purchase — it still takes its share of the charges, and the posting proposal sends what it came to straight to consumption. Only in a company whose settings allow it (expensed_on_purchase), refused otherwise as receipt.expensed_off — but a correction keeps a line the receipt being corrected already expensed, for the same part.
lines[].vat_non_deductiblebooleanThe line's tax cannot be deducted whoever the company is — reprezentace, for instance: it is part of what the line cost for a VAT payer too, and never in the line's lot, so no claim at registration takes it. Its share of the charges' tax follows it.
lines[].weight_gstringThe line's total shipping weight, as a packing list gives it.
accounting_nostringThe number the accounting software knows this invoice by. A reference only.
chargesobject[]At most 100: more is refused as 422 document.too_many_charges.
charges[].amountrequiredstringNever below zero, but for a rounding: the difference between the invoice's total and its lines, which corrects the price paid either way.
charges[].kindrequiredstringA vedlejší pořizovací náklad of vyhl. 500/2002 § 49 odst. 1, or a rounding of the invoice. Interest, penalties and anything else that is not part of acquisition cost is not a charge (since 24 October 2026).freightdutyimport_vathandlinginsurancepackagingcommissionrounding
charges[].basisstringPer charge, not per document: freight by weight and duty by value on one receipt is normal.valueweightquantitydirect
charges[].currencystring
charges[].direct_lineinteger
charges[].duzpstringThe charge's own tax point (DUZP), YYYY-MM-DD — a carrier's or a customs document dated apart from the goods' invoice. Whether its tax and an import VAT are reclaimable is read for it. Empty is the receipt's.
charges[].fxobjectThe rate as the document prints it.
charges[].fx.quoterequiredstringWhat they are worth in the currency on the right.
charges[].fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
charges[].fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
charges[].fx_ratestringThe rate as a bare multiplier. fx wins when both are sent.
charges[].provisionalbooleanAn estimate standing in for an invoice that has not arrived.
charges[].vat_amountstringThe tax printed on this charge's own line. Spread with the charge; part of the value only while the company is not VAT registered. Never below zero, but for a rounding.
charges[].vat_fxobjectThe rate the tax is converted at, when it is not fx.
charges[].vat_fx.quoterequiredstringWhat they are worth in the currency on the right.
charges[].vat_fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
charges[].vat_fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
closes_orderbooleanMark the order finished with, in the same request.
confirmbooleanGo ahead even though this moves figures already reported, or is dated ahead.
currencystringISO 4217. Empty is the company's own.
duzpstringThe tax point (DUZP), YYYY-MM-DD. Empty is the invoice's date, and with none the accounting date. Whether the company is VAT registered is read for this date.
fxobjectThe rate as the document prints it.
fx.quoterequiredstringWhat they are worth in the currency on the right.
fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
fx_notestring
fx_ratestringFrom the document, never fetched — so this rate and the accounting's agree by construction. A bare multiplier: company currency per one unit of the document's. fx wins when both are sent.
invoice_datestringYYYY-MM-DD. The date the invoice was issued — and its tax point when it states no DUZP.
ksef_nostringThe number KSeF gave the purchase invoice, as TNumerKSeF writes it. A reference.
occurred_atstring · date-time
positionstringWhere this goes among the documents already on a back-dated day.beforeafter
price_knownbooleanWith without_invoice: the prices are known from a contract or the vendor's delivery note rather than estimated. Ignored without it.
purchase_orderstringOrder number.
readingstringThe reading this was made from. Its document becomes the receipt's attachment.
reasonstringFrom the chart of accounts for receipts; empty for an ordinary purchase.
referencestringThe receipt's note.
supplier_doc_nostring
vat_fxobjectThe rate the lines' tax is converted at, when it is not fx.
vat_fx.quoterequiredstringWhat they are worth in the currency on the right.
vat_fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
vat_fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
vendorstringVendor code.
vendor_namestringThe vendor's name. Read-only; the code is what identifies them.
vendor_removedboolean
without_invoicebooleanThe goods arrived before the invoice and are priced by estimate. Cleared by the correction that enters the invoice; read back false as well once a price adjustment in force says it is the invoice.

Answer 201

4 fields
document_norequiredstring
idrequiredstring
revisionrequiredinteger
attachedstring

Refusals401403404409422429

What this receipt would cost, without posting it

POST/api/v1/receipts/preview

The same allocation the posting does, so what a preview promises and what the posting writes cannot drift. Nothing is written and nothing is numbered.

Example request
curl -X POST https://manufik.eu/api/v1/receipts/preview \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "accounting_date": "2026-01-31",
    "lines": [
      {
        "line_no": 1,
        "pn": "RES-0603-F-10K",
        "qty": "100",
        "unit_price": "12.50",
        "vat_amount": "12.50"
      }
    ]
  }'

Request body

accounting_daterequiredstring · date
linesrequiredobject[]At most 1000: more is refused as 422 document.too_many_lines.
lines[].line_norequiredintegerPosition on the invoice. It becomes the movement's ordinal, so a line that creates none leaves a gap.
lines[].pnrequiredstring
lines[].qtyrequiredstringBase units. A string, not a number.
lines[].unit_pricerequiredstringPer base unit, in the document's currency.
lines[].vat_amountrequiredstringRequired even while the company is not VAT registered. Zero is a value; a supplier not VAT registered charged none.
lines[].invoiced_qtystringWhat the paper said, if it was in packs.
lines[].line_totalstringWhat the invoice says the line comes to before VAT, in the document's currency, when it states a total rather than a unit price. It is what the line is costed at — quantity × a six-place unit price is a different amount once the quantity is large — and it must agree with qty × unit_price to the sixth place of the price.
lines[].locationstringThe bin it goes to. A line expensed on purchase (stocked: false) may leave it out: it goes to no shelf.
lines[].pack_sizestring
lines[].serialstringThe piece's number, for a part tracked by serial number. Such a line is one piece.
lines[].stockedbooleanDefault true. False expenses it on purchase — it still takes its share of the charges, and the posting proposal sends what it came to straight to consumption. Only in a company whose settings allow it (expensed_on_purchase), refused otherwise as receipt.expensed_off — but a correction keeps a line the receipt being corrected already expensed, for the same part.
lines[].vat_non_deductiblebooleanThe line's tax cannot be deducted whoever the company is — reprezentace, for instance: it is part of what the line cost for a VAT payer too, and never in the line's lot, so no claim at registration takes it. Its share of the charges' tax follows it.
lines[].weight_gstringThe line's total shipping weight, as a packing list gives it.
accounting_nostringThe number the accounting software knows this invoice by. A reference only.
chargesobject[]At most 100: more is refused as 422 document.too_many_charges.
charges[].amountrequiredstringNever below zero, but for a rounding: the difference between the invoice's total and its lines, which corrects the price paid either way.
charges[].kindrequiredstringA vedlejší pořizovací náklad of vyhl. 500/2002 § 49 odst. 1, or a rounding of the invoice. Interest, penalties and anything else that is not part of acquisition cost is not a charge (since 24 October 2026).freightdutyimport_vathandlinginsurancepackagingcommissionrounding
charges[].basisstringPer charge, not per document: freight by weight and duty by value on one receipt is normal.valueweightquantitydirect
charges[].currencystring
charges[].direct_lineinteger
charges[].duzpstringThe charge's own tax point (DUZP), YYYY-MM-DD — a carrier's or a customs document dated apart from the goods' invoice. Whether its tax and an import VAT are reclaimable is read for it. Empty is the receipt's.
charges[].fxobjectThe rate as the document prints it.
charges[].fx.quoterequiredstringWhat they are worth in the currency on the right.
charges[].fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
charges[].fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
charges[].fx_ratestringThe rate as a bare multiplier. fx wins when both are sent.
charges[].provisionalbooleanAn estimate standing in for an invoice that has not arrived.
charges[].vat_amountstringThe tax printed on this charge's own line. Spread with the charge; part of the value only while the company is not VAT registered. Never below zero, but for a rounding.
charges[].vat_fxobjectThe rate the tax is converted at, when it is not fx.
charges[].vat_fx.quoterequiredstringWhat they are worth in the currency on the right.
charges[].vat_fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
charges[].vat_fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
closes_orderbooleanMark the order finished with, in the same request.
confirmbooleanGo ahead even though this moves figures already reported, or is dated ahead.
currencystringISO 4217. Empty is the company's own.
duzpstringThe tax point (DUZP), YYYY-MM-DD. Empty is the invoice's date, and with none the accounting date. Whether the company is VAT registered is read for this date.
fxobjectThe rate as the document prints it.
fx.quoterequiredstringWhat they are worth in the currency on the right.
fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
fx_notestring
fx_ratestringFrom the document, never fetched — so this rate and the accounting's agree by construction. A bare multiplier: company currency per one unit of the document's. fx wins when both are sent.
invoice_datestringYYYY-MM-DD. The date the invoice was issued — and its tax point when it states no DUZP.
ksef_nostringThe number KSeF gave the purchase invoice, as TNumerKSeF writes it. A reference.
occurred_atstring · date-time
positionstringWhere this goes among the documents already on a back-dated day.beforeafter
price_knownbooleanWith without_invoice: the prices are known from a contract or the vendor's delivery note rather than estimated. Ignored without it.
purchase_orderstringOrder number.
readingstringThe reading this was made from. Its document becomes the receipt's attachment.
reasonstringFrom the chart of accounts for receipts; empty for an ordinary purchase.
referencestringThe receipt's note.
supplier_doc_nostring
vat_fxobjectThe rate the lines' tax is converted at, when it is not fx.
vat_fx.quoterequiredstringWhat they are worth in the currency on the right.
vat_fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
vat_fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
vendorstringVendor code.
vendor_namestringThe vendor's name. Read-only; the code is what identifies them.
vendor_removedboolean
without_invoicebooleanThe goods arrived before the invoice and are priced by estimate. Cleared by the correction that enters the invoice; read back false as well once a price adjustment in force says it is the invoice.

Answer 200

12 fields
chargesrequiredstring
linesrequiredobject[]
lines[].baserequiredstringThe invoice line in CZK, plus the tax when it cannot be reclaimed.
lines[].chargesrequiredstringIts share of every landed cost on the receipt.
lines[].line_norequiredinteger
lines[].stockedrequiredboolean
lines[].totalrequiredstringAcquisition cost of the line.
lines[].unitrequiredstringThat, per base unit. What the part's average will be moved toward.
lines[].vatrequiredstringThe tax recorded against the line in the company's currency — its own and its share of import VAT — whether or not it is in total. What the line's lot carries for § 79 ZDPH.
reclaimable_import_vatrequiredstringImport VAT a company that is VAT registered reclaims, left out of every line's value — a receivable, not stock.
totalrequiredstring
vat_payerrequiredbooleanWhether the tax on this receipt's DUZP is reclaimable. For a company not VAT registered it is part of what the stock cost.

Refusals401403404409422429

Read a posted goods receipt back

GET/api/v1/receipts/{id}

In the shape it was posted in — unit prices and charges, not movements.

Example request
curl https://manufik.eu/api/v1/receipts/{id} \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid

Answer 200

75 fields
accounting_daterequiredstring · date
linesrequiredobject[]At most 1000: more is refused as 422 document.too_many_lines.
lines[].line_norequiredintegerPosition on the invoice. It becomes the movement's ordinal, so a line that creates none leaves a gap.
lines[].pnrequiredstring
lines[].qtyrequiredstringBase units. A string, not a number.
lines[].unit_pricerequiredstringPer base unit, in the document's currency.
lines[].vat_amountrequiredstringRequired even while the company is not VAT registered. Zero is a value; a supplier not VAT registered charged none.
lines[].invoiced_qtystringWhat the paper said, if it was in packs.
lines[].line_totalstringWhat the invoice says the line comes to before VAT, in the document's currency, when it states a total rather than a unit price. It is what the line is costed at — quantity × a six-place unit price is a different amount once the quantity is large — and it must agree with qty × unit_price to the sixth place of the price.
lines[].locationstringThe bin it goes to. A line expensed on purchase (stocked: false) may leave it out: it goes to no shelf.
lines[].pack_sizestring
lines[].serialstringThe piece's number, for a part tracked by serial number. Such a line is one piece.
lines[].stockedbooleanDefault true. False expenses it on purchase — it still takes its share of the charges, and the posting proposal sends what it came to straight to consumption. Only in a company whose settings allow it (expensed_on_purchase), refused otherwise as receipt.expensed_off — but a correction keeps a line the receipt being corrected already expensed, for the same part.
lines[].vat_non_deductiblebooleanThe line's tax cannot be deducted whoever the company is — reprezentace, for instance: it is part of what the line cost for a VAT payer too, and never in the line's lot, so no claim at registration takes it. Its share of the charges' tax follows it.
lines[].weight_gstringThe line's total shipping weight, as a packing list gives it.
accounting_nostringThe number the accounting software knows this invoice by. A reference only.
chargesobject[]At most 100: more is refused as 422 document.too_many_charges.
charges[].amountrequiredstringNever below zero, but for a rounding: the difference between the invoice's total and its lines, which corrects the price paid either way.
charges[].kindrequiredstringA vedlejší pořizovací náklad of vyhl. 500/2002 § 49 odst. 1, or a rounding of the invoice. Interest, penalties and anything else that is not part of acquisition cost is not a charge (since 24 October 2026).freightdutyimport_vathandlinginsurancepackagingcommissionrounding
charges[].basisstringPer charge, not per document: freight by weight and duty by value on one receipt is normal.valueweightquantitydirect
charges[].currencystring
charges[].direct_lineinteger
charges[].duzpstringThe charge's own tax point (DUZP), YYYY-MM-DD — a carrier's or a customs document dated apart from the goods' invoice. Whether its tax and an import VAT are reclaimable is read for it. Empty is the receipt's.
charges[].fxobjectThe rate as the document prints it.
charges[].fx.quoterequiredstringWhat they are worth in the currency on the right.
charges[].fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
charges[].fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
charges[].fx_ratestringThe rate as a bare multiplier. fx wins when both are sent.
charges[].provisionalbooleanAn estimate standing in for an invoice that has not arrived.
charges[].vat_amountstringThe tax printed on this charge's own line. Spread with the charge; part of the value only while the company is not VAT registered. Never below zero, but for a rounding.
charges[].vat_fxobjectThe rate the tax is converted at, when it is not fx.
charges[].vat_fx.quoterequiredstringWhat they are worth in the currency on the right.
charges[].vat_fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
charges[].vat_fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
closes_orderbooleanMark the order finished with, in the same request.
confirmbooleanGo ahead even though this moves figures already reported, or is dated ahead.
costedobjectWhat each line came to — its own price in the company's currency, its share of the charges, and the two together — as preview-receipt answers it. Absent when the ledger holds other figures for the receipt than its costing gives today.
costed.chargesrequiredstringWhat the lines took of the charges, together.
costed.linesrequiredobject[]
costed.lines[].baserequiredstringThe invoice line in CZK, plus the tax when it cannot be reclaimed.
costed.lines[].chargesrequiredstringIts share of every landed cost on the receipt.
costed.lines[].line_norequiredinteger
costed.lines[].stockedrequiredboolean
costed.lines[].totalrequiredstringAcquisition cost of the line.
costed.lines[].unitrequiredstringThat, per base unit. What the part's average will be moved toward.
costed.lines[].vatrequiredstringThe tax recorded against the line in the company's currency — its own and its share of import VAT — whether or not it is in total. What the line's lot carries for § 79 ZDPH.
costed.reclaimable_import_vatrequiredstringImport VAT a company that is VAT registered reclaims, left out of every line's value — a receivable, not stock. Each charge read for its own DUZP.
costed.totalrequiredstringAcquisition cost of every line together.
costed.vat_payerrequiredbooleanWhether the tax on this receipt's DUZP is reclaimable. For a company not VAT registered it is part of what the stock cost. A charge with a DUZP of its own is read for that one.
currencystringISO 4217. Empty is the company's own.
duzpstringThe tax point (DUZP), YYYY-MM-DD. Empty is the invoice's date, and with none the accounting date. Whether the company is VAT registered is read for this date.
fxobjectThe rate as the document prints it.
fx.quoterequiredstringWhat they are worth in the currency on the right.
fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
fx_notestring
fx_ratestringFrom the document, never fetched — so this rate and the accounting's agree by construction. A bare multiplier: company currency per one unit of the document's. fx wins when both are sent.
invoice_datestringYYYY-MM-DD. The date the invoice was issued — and its tax point when it states no DUZP.
ksef_nostringThe number KSeF gave the purchase invoice, as TNumerKSeF writes it. A reference.
occurred_atstring · date-time
positionstringWhere this goes among the documents already on a back-dated day.beforeafter
price_knownbooleanWith without_invoice: the prices are known from a contract or the vendor's delivery note rather than estimated. Ignored without it.
purchase_orderstringOrder number.
readingstringThe reading this was made from. Its document becomes the receipt's attachment.
reasonstringFrom the chart of accounts for receipts; empty for an ordinary purchase.
referencestringThe receipt's note.
supplier_doc_nostring
vat_fxobjectThe rate the lines' tax is converted at, when it is not fx.
vat_fx.quoterequiredstringWhat they are worth in the currency on the right.
vat_fx.unitsrequiredstringHow many of the currency on the left: 1, or 100 for a currency quoted per hundred.
vat_fx.inversebooleanThe company's own currency is on the left — 1 EUR = 25.03 CZK in a euro company reading a crown invoice.
vendorstringVendor code.
vendor_namestringThe vendor's name. Read-only; the code is what identifies them.
vendor_removedboolean
without_invoicebooleanThe goods arrived before the invoice and are priced by estimate. Cleared by the correction that enters the invoice; read back false as well once a price adjustment in force says it is the invoice.

Refusals401403404409422429

Drafts

A document left for a person to finish and post.

Documents somebody has started

GET/api/v1/drafts

Most recently touched first. They also appear in the document list, marked as drafts.

Example request
curl https://manufik.eu/api/v1/drafts \
  -H "Authorization: Bearer mfk_…"

Answer 200

5 fields
draftsrequiredobject[]
drafts[].idrequiredstring
drafts[].linesrequiredinteger
drafts[].updated_atrequiredstring
drafts[].actorstring

Refusals401403404409422429

Read one back to carry on with

GET/api/v1/drafts/{id}

Example request
curl https://manufik.eu/api/v1/drafts/{id} \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid

Answer 200

8 fields
linesrequiredvalue[]The form's own line shape. Half-typed values are legitimate here.
typerequiredstring
accounting_datestringYYYY-MM-DD. Empty is legitimate: a draft is half-typed by definition.
reasonstring
receiptThe form's own state beside its lines, in the form's own shape. The receipt screen's: vendor, invoice, dates, currency, order and charges; the document form's: who a goods issue goes to, a scrap's disposal record, and whether an opening is already in the books.
referencestring
screenstringThe form that wrote it. Absent on drafts older than the field.documentreceipt
updated_atstringWhen it was last saved, as get-draft answers it. Sent back with save-draft, it refuses a save over a draft somebody saved or removed since: 409 draft.changed_meanwhile.

Refusals401403404409422429

Write down where somebody has got to

PUT/api/v1/drafts/{id}

The client chooses the id, so a draft that has never reached the server and one that has are the same thing to it.

Example request
curl -X PUT https://manufik.eu/api/v1/drafts/{id} \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "lines": [
      "string"
    ]
  }'

Parameters

idrequiredpath · string · uuid
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

linesrequiredvalue[]The form's own line shape. Half-typed values are legitimate here.
typerequiredstring
accounting_datestringYYYY-MM-DD. Empty is legitimate: a draft is half-typed by definition.
reasonstring
receiptThe form's own state beside its lines, in the form's own shape. The receipt screen's: vendor, invoice, dates, currency, order and charges; the document form's: who a goods issue goes to, a scrap's disposal record, and whether an opening is already in the books.
referencestring
screenstringThe form that wrote it. Absent on drafts older than the field.documentreceipt
updated_atstringWhen it was last saved, as get-draft answers it. Sent back with save-draft, it refuses a save over a draft somebody saved or removed since: 409 draft.changed_meanwhile.

Answer 204no body

Refusals401403404409422429

Throw one away

DELETE/api/v1/drafts/{id}

Example request
curl -X DELETE https://manufik.eu/api/v1/drafts/{id} \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid
updated_atquery · stringWhen the draft was last saved, as get-draft answered it. Given, a draft somebody saved since is not thrown away: 409 draft.changed_meanwhile. A draft already gone is gone either way.
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Answer 204no body

Refusals401403404409422429

Vendors

Who the company buys from, and their numbers for its parts.

Who we buy from

GET/api/v1/vendors

Example request
curl https://manufik.eu/api/v1/vendors \
  -H "Authorization: Bearer mfk_…"

Answer 200

17 fields
vendorsrequiredobject[]
vendors[].coderequiredstring
vendors[].formatrequiredstringgenericdigikeymouser
vendors[].namerequiredstring
vendors[].ordersrequiredintegerPurchase orders naming this vendor. They survive the vendor's removal too.
vendors[].partsrequiredintegerLines of this vendor's catalogue, whether or not each is matched to a part of ours.
vendors[].receiptsrequiredintegerGoods receipts naming this vendor. They survive the vendor's removal, keeping the name.
vendors[].addressobjectStreet and number, postal code and town, apart.
vendors[].address.citystringTown, with the postal district where the post uses one ("Praha 1").
vendors[].address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
vendors[].address.streetstringStreet and number — the first line of the address.
vendors[].countrystringISO 3166 alpha-2. Inside or outside the EU decides import VAT and duty.
vendors[].icostringThe identifier in the vendor's own register, by the vendor's country — an IČO in CZ and SK, a NIP in PL.
vendors[].lead_daysintegerHow long they take to deliver, in days, as somebody typed it.
vendors[].notestring
vendors[].urlstring
vendors[].vat_idstringThe VAT identification number with its country prefix.

Refusals401403404409422429

Add a vendor

POST/api/v1/vendors

Example request
curl -X POST https://manufik.eu/api/v1/vendors \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "ACME",
    "name": "Acme s.r.o."
  }'

Parameters

Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

coderequiredstring
namerequiredstring
addressobject
address.citystringTown, with the postal district where the post uses one ("Praha 1").
address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
address.streetstringStreet and number — the first line of the address.
countrystring
formatstringgenericdigikeymouser
icostringThe identifier in the vendor's own register, checked by their country: in CZ eight digits with a check digit. Spaces and missing leading zeros are forgiven.
lead_daysintegerHow long they take to deliver, in days. Zero clears it; absent keeps it.
notestring
urlstring
vat_idstringThe VAT identification number with its country prefix.

Answer 201no body

Refusals401403404409422429

One vendor, and every part they have a number for

GET/api/v1/vendors/{code}

Example request
curl https://manufik.eu/api/v1/vendors/{code} \
  -H "Authorization: Bearer mfk_…"

Parameters

coderequiredpath · string

Answer 200

25 fields
partsrequiredobject[]
parts[].descriptionrequiredstring
parts[].on_handrequiredstring
parts[].pack_sizerequiredstring
parts[].pnrequiredstring
parts[].skurequiredstring
parts[].unitrequiredstring
parts[].pack_labelstringWhat one pack is called: reel, spool, cut tape.
vendorrequiredobject
vendor.coderequiredstring
vendor.formatrequiredstringgenericdigikeymouser
vendor.namerequiredstring
vendor.ordersrequiredintegerPurchase orders naming this vendor. They survive the vendor's removal too.
vendor.partsrequiredintegerLines of this vendor's catalogue, whether or not each is matched to a part of ours.
vendor.receiptsrequiredintegerGoods receipts naming this vendor. They survive the vendor's removal, keeping the name.
vendor.addressobjectStreet and number, postal code and town, apart.
vendor.address.citystringTown, with the postal district where the post uses one ("Praha 1").
vendor.address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
vendor.address.streetstringStreet and number — the first line of the address.
vendor.countrystringISO 3166 alpha-2. Inside or outside the EU decides import VAT and duty.
vendor.icostringThe identifier in the vendor's own register, by the vendor's country — an IČO in CZ and SK, a NIP in PL.
vendor.lead_daysintegerHow long they take to deliver, in days, as somebody typed it.
vendor.notestring
vendor.urlstring
vendor.vat_idstringThe VAT identification number with its country prefix.

Refusals401403404409422429

Change a vendor's details

PATCH/api/v1/vendors/{code}

The code is not among them: it is on receipts and in order lists already. A field left out is left as it is; a field sent empty is cleared.

Example request
curl -X PATCH https://manufik.eu/api/v1/vendors/{code} \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "address": {
      "city": "string"
    }
  }'

Parameters

coderequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

addressobjectReplaced whole when sent, its three parts together. Absent keeps it.
address.citystringTown, with the postal district where the post uses one ("Praha 1").
address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
address.streetstringStreet and number — the first line of the address.
codestringIgnored: the code is the path's, and does not change. Optional.
countrystringISO 3166 alpha-2. Absent keeps it; empty clears it.
formatstringHow they take an order list. Absent keeps it.genericdigikeymouser
icostringThe identifier in the vendor's own register, checked by their country: in CZ eight digits with a check digit. Spaces and missing leading zeros are forgiven. Absent keeps it; empty clears it.
lead_daysintegerHow long they take to deliver, in days. Zero clears it; absent keeps it.
namestringAbsent keeps it; it cannot be cleared.
notestringAbsent keeps it; empty clears it.
urlstringAbsent keeps it; empty clears it.
vat_idstringThe VAT identification number with its country prefix. Absent keeps it; empty clears it.

Answer 204no body

Refusals401403404409422429

What this vendor sells, and which of it we have matched

GET/api/v1/vendors/{code}/catalogue

Example request
curl https://manufik.eu/api/v1/vendors/{code}/catalogue \
  -H "Authorization: Bearer mfk_…"

Parameters

coderequiredpath · string
qquery · stringSubstring of their number or their description.
matchedquery · string
afterquery · stringThe next of the previous block. Empty is the first block.
limitquery · integer

Answer 200

14 fields
linesrequiredobject[]
lines[].idrequiredstring
lines[].importedrequiredbooleanIt came from one of their files rather than being typed in here.
lines[].pack_sizerequiredstring
lines[].skurequiredstring
lines[].descriptionstring
lines[].mpnstring
lines[].pack_labelstring
lines[].pnstringOur part, when somebody has matched it. Empty means unmatched — never a guess.
lines[].unitstring
lines[].urlstring
matchingrequiredintegerAfter the filter: how many lines the blocks add up to. On the first block only.
totalrequiredintegerBefore the filter.
nextstringWhere this block ended. Absent on the last one.

Refusals401403404409422429

What this vendor calls one of our parts

PUT/api/v1/vendors/{code}/parts/{pn}

Idempotent: the pair is the key, so setting it twice corrects it rather than duplicating it. A number of theirs another part already has is refused, naming that part: it is moved on the vendor's catalogue.

Example request
curl -X PUT https://manufik.eu/api/v1/vendors/{code}/parts/{pn} \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "sku": "311-10.0KHRCT-ND"
  }'

Parameters

coderequiredpath · string
pnrequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

skurequiredstringTheir number, as they print it. Never uppercased: a SKU is theirs and case can be part of it.
barcodestringThe number on their label when it is not their SKU. Omit to leave it alone; send "" to clear it.
mpnstringThe manufacturer's own number. Omit to leave it alone; send "" to clear it.
pack_labelstringWhat one pack is called. Omit to leave it alone; send "" to clear it.
pack_sizestringHow many base units in one pack. A spool of 1000 g is 1000, not a unit conversion. Omit to leave it alone.
urlstringTheir page for this part. Omit to leave it alone; send "" to clear it.

Answer 204no body

Refusals401403404409422429

Forget that this vendor sells this part

DELETE/api/v1/vendors/{code}/parts/{pn}

Example request
curl -X DELETE https://manufik.eu/api/v1/vendors/{code}/parts/{pn} \
  -H "Authorization: Bearer mfk_…"

Parameters

coderequiredpath · string
pnrequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Answer 204no body

Refusals401403404409422429

Customers

Who the company sells to.

Who we make things for

GET/api/v1/customers

Example request
curl https://manufik.eu/api/v1/customers \
  -H "Authorization: Bearer mfk_…"

Answer 200

14 fields
customersrequiredobject[]
customers[].coderequiredstring
customers[].namerequiredstring
customers[].openrequiredintegerOf those, the ones not finished: a product neither made nor cancelled, or a line from stock neither cancelled nor all handed over.
customers[].ordersrequiredintegerBuild orders for them. One is enough to stop them being removed.
customers[].addressobject
customers[].address.citystringTown, with the postal district where the post uses one ("Praha 1").
customers[].address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
customers[].address.streetstringStreet and number — the first line of the address.
customers[].contactstring
customers[].countrystring
customers[].icostring
customers[].notestring
customers[].vat_idstring

Refusals401403404409422429

Add a customer

POST/api/v1/customers

Example request
curl -X POST https://manufik.eu/api/v1/customers \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "ACME",
    "name": "Acme s.r.o."
  }'

Parameters

Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

coderequiredstring
namerequiredstring
addressobject
address.citystringTown, with the postal district where the post uses one ("Praha 1").
address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
address.streetstringStreet and number — the first line of the address.
contactstring
countrystringISO 3166 alpha-2. Empty is the company's own, which decides how the identifier is checked.
icostringThe identifier in the customer's own register, checked by their country: in CZ eight digits with a check digit. Spaces and missing leading zeros are forgiven.
notestring
vat_idstringThe VAT identification number with its country prefix.

Answer 201no body

Refusals401403404409422429

Change a customer's details

PATCH/api/v1/customers/{code}

The code is not among them: it is in every build order that names them. A field left out is left as it is; a field sent empty is cleared.

Example request
curl -X PATCH https://manufik.eu/api/v1/customers/{code} \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "address": {
      "city": "string"
    }
  }'

Parameters

coderequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

addressobjectReplaced whole when sent, its three parts together. Absent keeps it.
address.citystringTown, with the postal district where the post uses one ("Praha 1").
address.postal_codestringPostal code, "415 01" for a Czech or Slovak one.
address.streetstringStreet and number — the first line of the address.
codestringIgnored: the code is the path's, and does not change. Optional.
contactstringAbsent keeps it; empty clears it.
countrystringISO 3166 alpha-2. Empty is the company's own, which decides how the identifier is checked. Absent keeps it.
icostringThe identifier in the customer's own register, checked by their country: in CZ eight digits with a check digit. Spaces and missing leading zeros are forgiven. Absent keeps it; empty clears it.
namestringAbsent keeps it; it cannot be cleared.
notestringAbsent keeps it; empty clears it.
vat_idstringThe VAT identification number with its country prefix. Absent keeps it; empty clears it.

Answer 204no body

Refusals401403404409422429

Purchase orders

Orders to vendors, from a list to something on its way.

What we have ordered

GET/api/v1/orders

Example request
curl https://manufik.eu/api/v1/orders \
  -H "Authorization: Bearer mfk_…"

Answer 200

16 fields
ordersrequiredobject[]
orders[].created_atrequiredstring
orders[].linesrequiredinteger
orders[].numberrequiredstring
orders[].receiptsrequiredinteger
orders[].statusrequiredstringdraftsentclosedcancelled
orders[].vendorrequiredstring
orders[].vendor_namerequiredstring
orders[].cancel_reasonstring
orders[].expected_fromstringWhat said so: the day written on the order, the vendor's lead time measured on its earlier orders, or the one typed on the vendor.typedmeasuredvendor
orders[].expected_onstring · dateWhen it is expected: the day written on it, or else sent plus the vendor's lead time. In the list, only for an order still waited for.
orders[].notestring
orders[].overduebooleanSent, something on it still to arrive, and its day has passed by the company's own date. In the list.
orders[].sent_atstringWhen it went to the vendor. Kept on an order put back to a draft once something has arrived against it, and on an order closed.
orders[].vendor_refstringThe vendor's own number for this order — their sales order or confirmation.
orders[].vendor_removedboolean

Refusals401403404409422429

Start an order to a vendor

POST/api/v1/orders

With `from_builds`, it is filled with whatever the unfinished products of build orders are short of and this vendor has a number for.

Example request
curl -X POST https://manufik.eu/api/v1/orders \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor": "ACME"
  }'

Parameters

Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

vendorrequiredstring
from_buildsbooleanFill it from what the unfinished products of build orders are short of.
notestring

Answer 201

2 fields
linesrequiredinteger
numberrequiredstring

Refusals401403404409422429

One order, its lines, and the list the vendor reads

GET/api/v1/orders/{number}

The list is generated now rather than stored: their packaging is theirs to change.

Example request
curl https://manufik.eu/api/v1/orders/{number} \
  -H "Authorization: Bearer mfk_…"

Parameters

numberrequiredpath · string

Answer 200

46 fields
formatrequiredstringHow this vendor takes a list.
linesrequiredobject[]
lines[].averagerequiredstringWhat one costs: the weighted average of what the part holds, and for a part that holds nothing the average its last pieces left at. Zero for a part that never had a price. Not a vendor's price.
lines[].binsrequiredstring[]Every bin holding a non-zero quantity of it, by code.
lines[].descriptionrequiredstring
lines[].missingrequiredstringWhat this order still waits for of it: the quantity less what was received, and never below nought — an over-delivery is not a negative order.
lines[].on_handrequiredstring
lines[].orderedrequiredstringOutstanding across every sent order, this one included.
lines[].pnrequiredstring
lines[].qtyrequiredstringIn the part's base unit.
lines[].receivedrequiredstringWhat the goods receipts naming this order took in of it, in force: a corrected receipt as it now stands, a deleted one not at all.
lines[].unitrequiredstring
lines[].buildstringThe product of a build order this line came from, when it came from one.
lines[].pack_sizestring
lines[].packsstringWhole packs, rounded up: half a reel is not a thing they sell.
lines[].skustringEmpty when the vendor has no number for it, which is what stops it reaching their list.
listrequiredstringReady to paste. Only the lines the vendor has a number for.
orderrequiredobject
order.created_atrequiredstring
order.linesrequiredinteger
order.numberrequiredstring
order.receiptsrequiredinteger
order.statusrequiredstringdraftsentclosedcancelled
order.vendorrequiredstring
order.vendor_namerequiredstring
order.cancel_reasonstring
order.expected_fromstringWhat said so: the day written on the order, the vendor's lead time measured on its earlier orders, or the one typed on the vendor.typedmeasuredvendor
order.expected_onstring · dateWhen it is expected: the day written on it, or else sent plus the vendor's lead time. In the list, only for an order still waited for.
order.notestring
order.overduebooleanSent, something on it still to arrive, and its day has passed by the company's own date. In the list.
order.sent_atstringWhen it went to the vendor. Kept on an order put back to a draft once something has arrived against it, and on an order closed.
order.vendor_refstringThe vendor's own number for this order — their sales order or confirmation.
order.vendor_removedboolean
receipt_documentsrequiredobject[]The goods receipts naming the order, as they now stand, oldest first — the documents order.receipts counts.
receipt_documents[].accounting_daterequiredstringYYYY-MM-DD.
receipt_documents[].document_norequiredstring
receipt_documents[].idrequiredstring
sourcesrequiredobject[]The bills of materials it was filled from, oldest first.
sources[].created_atrequiredstring
sources[].descriptionrequiredstring
sources[].linesrequiredintegerHow many of this order's lines it added or added to.
sources[].pnrequiredstring
sources[].qtyrequiredstringHow many products' worth.
sources[].revrequiredstring
sources[].only_missingbooleanOnly what was missing, rather than everything the products take.
unknownrequiredstring[]Lines they have no number for, which is why they are not on the list.

Refusals401403404409422429

Say it is not going to happen

POST/api/v1/orders/{number}/cancel

A draft or an order already sent. Refused once anything has arrived against it — close that one instead.

Example request
curl -X POST https://manufik.eu/api/v1/orders/{number}/cancel \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'

Parameters

numberrequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

reasonstringWhat the vendor said. Optional, and the only part of a cancelled order anybody reads later.

Answer 204no body

Refusals401403404409422429

Put a part on an order, or change how many

PUT/api/v1/orders/{number}/lines/{pn}

A part that is assembled puts its components on instead, recursively — you cannot buy a board we make. Only components this vendor has a number for go on; the rest come back in `skipped`. What a customer supplies is never ordered: such a component comes back in `customer_owned`, and such a part asked for by itself is refused. An assembled part with no released revision, which this vendor has a number for, goes on as itself. A part already on the order has its quantity set, whatever it is made of: nothing is unfolded.

Example request
curl -X PUT https://manufik.eu/api/v1/orders/{number}/lines/{pn} \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "qty": "100"
  }'

Parameters

numberrequiredpath · string
pnrequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

qtyrequiredstring

Answer 200

3 fields
addedrequiredintegerHow many lines the order gained or had changed.
customer_ownedrequiredstring[]Components a customer supplies, which are never ordered and therefore not on the order.
skippedrequiredstring[]Components this vendor has no number for, and which are therefore not on the order.

Refusals401403404409422429

Take a part off an order

DELETE/api/v1/orders/{number}/lines/{pn}

Example request
curl -X DELETE https://manufik.eu/api/v1/orders/{number}/lines/{pn} \
  -H "Authorization: Bearer mfk_…"

Parameters

numberrequiredpath · string
pnrequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Answer 204no body

Refusals401403404409422429

Say it has gone to the vendor

POST/api/v1/orders/{number}/send

Example request
curl -X POST https://manufik.eu/api/v1/orders/{number}/send \
  -H "Authorization: Bearer mfk_…"

Parameters

numberrequiredpath · string
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Answer 204no body

Refusals401403404409422429

Build orders

What a customer ordered — products to make, parts from stock — and what it holds.

List build orders

GET/api/v1/build-jobs

Newest first, one row per build order with its products summed up.

Example request
curl https://manufik.eu/api/v1/build-jobs \
  -H "Authorization: Bearer mfk_…"

Parameters

statusquery · stringEmpty means every state; live is everything not finished or cancelled.

Answer 200

66 fields
jobsrequiredobject[]
jobs[].created_atrequiredstring
jobs[].deliveriesrequiredobject[]
jobs[].deliveries[].accounting_daterequiredstring · date
jobs[].deliveries[].customerrequiredstringThe code of the customer it went to.
jobs[].deliveries[].customer_namerequiredstringTheir name as the goods issue copied it.
jobs[].deliveries[].document_norequiredstring
jobs[].deliveries[].idrequiredstring
jobs[].deliveries[].note_idstringThe delivery note it is on, cancelled ones aside. Empty while it waits for one.
jobs[].deliveries[].note_nostring
jobs[].documentsrequiredobject[]The VR document of each completed product.
jobs[].documents[].document_norequiredstring
jobs[].documents[].idrequiredstring
jobs[].donerequiredstringOf those, the pieces completed.
jobs[].idrequiredstring
jobs[].job_norequiredstring
jobs[].productsrequiredobject[]
jobs[].products[].descriptionrequiredstring
jobs[].products[].idrequiredstring
jobs[].products[].pnrequiredstring
jobs[].products[].qtyrequiredstring
jobs[].products[].statusrequiredstring
jobs[].products[].split_fromstringThe product this was split off, so the parts of one can be said as one.
jobs[].qtyrequiredstringPieces across the products that are not cancelled.
jobs[].servicesrequiredstring
jobs[].shortrequiredintegerComponents short for the products not yet reserved and the lines from stock that hold nothing, taken together.
jobs[].short_partsrequiredobject[]
jobs[].short_parts[].descriptionrequiredstring
jobs[].short_parts[].freerequiredstringOn hand less what reserved orders hold.
jobs[].short_parts[].neededrequiredstringBy every product of the build order not yet reserved, together — and by the sub-assemblies they need that nobody is making yet, which are made when they are.
jobs[].short_parts[].pnrequiredstring
jobs[].short_parts[].shortrequiredstring
jobs[].short_parts[].unitrequiredstring
jobs[].short_parts[].builtbooleanThe part is made here: its drawing — the released revision, else the newest draft — fits something. Absent for a part that is bought, a drawn one whose drawing fits nothing included.
jobs[].short_parts[].for_substringOf what is needed, how much the sub-assemblies take that nobody is making yet. Absent when none.
jobs[].short_parts[].makingstringHow much of it the build order's own products still to be made will make. Absent when none.
jobs[].statusrequiredstringRead off the products: partial is some completed and some still to do.newreservedin_progresspartialpostedcancelled
jobs[].stockrequiredobject[]
jobs[].stock[].deliveredrequiredstringWhat the build order's goods issues took of the part, less what the customer returned against them.
jobs[].stock[].descriptionrequiredstring
jobs[].stock[].freerequiredstringWhat anybody but this line may still take of the part.
jobs[].stock[].idrequiredstring
jobs[].stock[].pnrequiredstring
jobs[].stock[].qtyrequiredstring
jobs[].stock[].remainingrequiredstringStill to hand over.
jobs[].stock[].staterequiredstringWhere it stands today: reserved and past the build order's date is expired, and holds nothing; nothing left to hand over is delivered.newreservedexpireddeliveredcancelled
jobs[].stock[].statusrequiredstringWhat was done to it.newreservedcancelled
jobs[].stock[].unitrequiredstring
jobs[].stock[].notestring
jobs[].stock[].sale_pricestringWhat its part is sold for today. Absent when the part has no price.
jobs[].actorstring
jobs[].coststringProduction cost of the products completed so far. Absent while none is.
jobs[].customerstring
jobs[].customer_namestring
jobs[].deliveries_togetherbooleanTwo or more of its goods issues wait for a delivery note, every one to the same customer and naming them alike: one delivery note can be issued from all of them.
jobs[].due_onstring
jobs[].managementstringCalculation price of everything it delivers: products made at what their runs came to, products to make at today's calculation, lines from stock at the part's average. Posted nowhere.
jobs[].management_estimatedbooleanPart of it is a calculation or an average rather than a run's own figure.
jobs[].notestring
jobs[].referencestring
jobs[].reserve_untilstringThe last day its lines from stock are held. Absent: until cancelled.
jobs[].sale_coststringThe calculation price of what the value counts: of the lines that have a price.
jobs[].sale_estimatedbooleanPart of the cost is today's calculation of a product not yet made, or a part's average.
jobs[].sale_partialbooleanSome of its parts have no price and are not in the value.
jobs[].sale_valuestringAbsent when none of its parts has a price.
jobs[].service_kindsstring[]The kinds of service booked on its products, each once, in the order of their names. Absent when none.

Refusals401403404409422429

Raise a build order of one or more products

POST/api/v1/build-jobs

Numbered when it is raised. Each product is reserved, started and completed on its own, and holds nothing until it is reserved.

Example request
curl -X POST https://manufik.eu/api/v1/build-jobs \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": "ACME"
  }'

Parameters

Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

customerstringCustomer code. Empty means for stock.
due_onstringYYYY-MM-DD. When the customer is expecting it.
linesobject[]The products, each reserved, started and completed on its own.
lines[].partrequiredstring
lines[].qtyrequiredstring
lines[].revisionrequiredstringMust be released.
lines[].notestring
lines[].servicesobject[]
lines[].services[].amountrequiredstring
lines[].services[].kindrequiredstringBoard fabrication, a stencil, somebody else's assembly.
notestring
referencestringTheir number for it.
reserve_untilstringYYYY-MM-DD. The last day its lines from stock are held; empty is until cancelled.
stockobject[]Parts taken from stock rather than made. A build order has at least one product or one of these.
stock[].partrequiredstring
stock[].qtyrequiredstring
stock[].notestring

Answer 201

2 fields
idrequiredstring
job_norequiredstring

Refusals401403404409422429

Read one build order and its products

GET/api/v1/build-jobs/{id}

Example request
curl https://manufik.eu/api/v1/build-jobs/{id} \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid

Answer 200

37 fields
buildsrequiredobject[]Its products, each reserved, started and completed on its own — and the sub-assemblies made for them, each naming its product in made_for.
builds[].created_atrequiredstring
builds[].descriptionrequiredstring
builds[].idrequiredstring
builds[].job_idrequiredstringEmpty for a product taken off its build order after it was made.
builds[].job_norequiredstring
builds[].pnrequiredstring
builds[].qtyrequiredstring
builds[].revrequiredstring
builds[].serializedrequiredboolean
builds[].servicesrequiredstringExternal services booked against the run — board fabrication, somebody else's assembly.
builds[].shortrequiredinteger
builds[].statusrequiredstringnewreservedin_progresspostedcancelled
builds[].actorstring
builds[].coststring
builds[].customerstring
builds[].customer_namestring
builds[].document_idstring
builds[].document_nostring
builds[].due_onstring
builds[].has_servicesbooleanThe run has a service line, whatever its estimate.
builds[].locationstring
builds[].made_forstringThe product of the same build order this is a sub-assembly for. Absent on a product somebody ordered.
builds[].managementstringCalculation price of the whole run. Posted nowhere.
builds[].management_estimatedbooleanThe run is not made yet, or a component's cost is an estimate: the figure is today's calculation.
builds[].notestring
builds[].referencestring
builds[].reservablestringHow many whole pieces of a product short of parts the free parts cover now, when at least one: so much of it could be reserved apart. Absent when all of it can be reserved, when it already holds, and when not one piece can.
builds[].sale_pricestring
builds[].serial_maskstring
builds[].service_linesobject[]
builds[].service_lines[].amountrequiredstringThe estimate the product's value carries.
builds[].service_lines[].idrequiredstring
builds[].service_lines[].kindrequiredstring
builds[].service_lines[].invoice_nostringThe supplier's document.
builds[].service_lines[].invoicedstringWhat the supplier invoiced for it; absent until somebody writes it.
builds[].split_fromstringThe product this was split off, when it was: the original one, so parts of it group on one equality.

Refusals401403404409422429

Correct who a build order is for, when, and what they call it

PATCH/api/v1/build-jobs/{id}

The header only, in any state: who a finished build order was for can still be put right. A field left out is left as it is; a field sent empty is cleared. The customer is not changed to another than the one goods issues naming the build order went to (build_job.delivered_to_other); for stock — none — always is.

Example request
curl -X PATCH https://manufik.eu/api/v1/build-jobs/{id} \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": "ACME"
  }'

Parameters

idrequiredpath · string · uuid
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

customerstringCustomer code. Empty means for stock. Absent keeps it.
due_onstringYYYY-MM-DD. When the customer is expecting it. Absent keeps it; empty clears it.
notestringAbsent keeps it; empty clears it.
referencestringAbsent keeps it; empty clears it.
reserve_untilstringYYYY-MM-DD. The last day its lines from stock are held; empty is until cancelled. Absent keeps it.

Answer 204no body

Refusals401403404409422429

Abandon every product of a build order not yet completed

POST/api/v1/build-jobs/{id}/cancel

What was completed stays completed: a product in stock is not unmade by a customer changing their mind.

Example request
curl -X POST https://manufik.eu/api/v1/build-jobs/{id}/cancel \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Answer 204no body

Refusals401403404409422429

Give back what a build order's lines from stock hold

POST/api/v1/build-jobs/{id}/release-stock

The lines stay, as demand: they can be reserved again.

Example request
curl -X POST https://manufik.eu/api/v1/build-jobs/{id}/release-stock \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Answer 204no body

Refusals401403404409422429

Hold a build order's lines from stock for its customer

POST/api/v1/build-jobs/{id}/reserve-stock

Every line that holds nothing — written and not reserved, or reserved past its date — together, or none of them: refused, naming what is short, when the quantity is not free. Free is what may be taken less what build orders and other customers hold.

Example request
curl -X POST https://manufik.eu/api/v1/build-jobs/{id}/reserve-stock \
  -H "Authorization: Bearer mfk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "reserve_until": "string"
  }'

Parameters

idrequiredpath · string · uuid
Idempotency-Keyheader · stringA name the program gives this request, so that sending it again does not do it twice — see Sending a request again.

Request body

reserve_untilstringYYYY-MM-DD. A new last day, set before reserving — what a build order whose date has passed needs.
until_cancelledbooleanNo last day: held until cancelled.

Answer 204no body

Refusals401403404409422429

Products

The products of build orders, being made, to read.

List the products of build orders

GET/api/v1/builds

Newest first. An open order is a plan and has no cost yet; a posted one points at the document it became.

Example request
curl https://manufik.eu/api/v1/builds \
  -H "Authorization: Bearer mfk_…"

Parameters

statusquery · stringEmpty means every state.

Answer 200

37 fields
buildsrequiredobject[]
builds[].created_atrequiredstring
builds[].descriptionrequiredstring
builds[].idrequiredstring
builds[].job_idrequiredstringEmpty for a product taken off its build order after it was made.
builds[].job_norequiredstring
builds[].pnrequiredstring
builds[].qtyrequiredstring
builds[].revrequiredstring
builds[].serializedrequiredboolean
builds[].servicesrequiredstringExternal services booked against the run — board fabrication, somebody else's assembly.
builds[].shortrequiredinteger
builds[].statusrequiredstringnewreservedin_progresspostedcancelled
builds[].actorstring
builds[].coststring
builds[].customerstring
builds[].customer_namestring
builds[].document_idstring
builds[].document_nostring
builds[].due_onstring
builds[].has_servicesbooleanThe run has a service line, whatever its estimate.
builds[].locationstring
builds[].made_forstringThe product of the same build order this is a sub-assembly for. Absent on a product somebody ordered.
builds[].managementstringCalculation price of the whole run. Posted nowhere.
builds[].management_estimatedbooleanThe run is not made yet, or a component's cost is an estimate: the figure is today's calculation.
builds[].notestring
builds[].referencestring
builds[].reservablestringHow many whole pieces of a product short of parts the free parts cover now, when at least one: so much of it could be reserved apart. Absent when all of it can be reserved, when it already holds, and when not one piece can.
builds[].sale_pricestring
builds[].serial_maskstring
builds[].service_linesobject[]
builds[].service_lines[].amountrequiredstringThe estimate the product's value carries.
builds[].service_lines[].idrequiredstring
builds[].service_lines[].kindrequiredstring
builds[].service_lines[].invoice_nostringThe supplier's document.
builds[].service_lines[].invoicedstringWhat the supplier invoiced for it; absent until somebody writes it.
builds[].split_fromstringThe product this was split off, when it was: the original one, so parts of it group on one equality.

Refusals401403404409422429

Read one product of a build order

GET/api/v1/builds/{id}

Example request
curl https://manufik.eu/api/v1/builds/{id} \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid

Answer 200

36 fields
created_atrequiredstring
descriptionrequiredstring
idrequiredstring
job_idrequiredstringEmpty for a product taken off its build order after it was made.
job_norequiredstring
pnrequiredstring
qtyrequiredstring
revrequiredstring
serializedrequiredboolean
servicesrequiredstringExternal services booked against the run — board fabrication, somebody else's assembly.
shortrequiredinteger
statusrequiredstringnewreservedin_progresspostedcancelled
actorstring
coststring
customerstring
customer_namestring
document_idstring
document_nostring
due_onstring
has_servicesbooleanThe run has a service line, whatever its estimate.
locationstring
made_forstringThe product of the same build order this is a sub-assembly for. Absent on a product somebody ordered.
managementstringCalculation price of the whole run. Posted nowhere.
management_estimatedbooleanThe run is not made yet, or a component's cost is an estimate: the figure is today's calculation.
notestring
referencestring
reservablestringHow many whole pieces of a product short of parts the free parts cover now, when at least one: so much of it could be reserved apart. Absent when all of it can be reserved, when it already holds, and when not one piece can.
sale_pricestring
serial_maskstring
service_linesobject[]
service_lines[].amountrequiredstringThe estimate the product's value carries.
service_lines[].idrequiredstring
service_lines[].kindrequiredstring
service_lines[].invoice_nostringThe supplier's document.
service_lines[].invoicedstringWhat the supplier invoiced for it; absent until somebody writes it.
split_fromstringThe product this was split off, when it was: the original one, so parts of it group on one equality.

Refusals401403404409422429

What this order needs, and whether it is there

GET/api/v1/builds/{id}/requirements

Free is on hand less what other orders hold. An order that already holds does not count itself.

Example request
curl https://manufik.eu/api/v1/builds/{id}/requirements \
  -H "Authorization: Bearer mfk_…"

Parameters

idrequiredpath · string · uuid

Answer 200

15 fields
requirementsrequiredobject[]
requirements[].customer_ownedrequiredbooleanMaterial the customer supplied: consumed, and worth nothing to the product.
requirements[].descriptionrequiredstring
requirements[].freerequiredstring
requirements[].neededrequiredstring
requirements[].on_handrequiredstring
requirements[].orderedrequiredstringStill coming, from orders already sent. It does not make a part reservable.
requirements[].pnrequiredstring
requirements[].reservedrequiredstringWhat other orders hold. This one never counts itself.
requirements[].serializedrequiredbooleanThe pieces that go in have to be named at completion.
requirements[].shortrequiredstringZero when there is enough. Never negative.
requirements[].unitrequiredstring
requirements[].averagestringWhat one costs on the shelf today — the weighted average, and of a part that has run out the average its last pieces left at. Absent for a part that has never been in stock.
requirements[].serial_maskstringThe shape those numbers are meant to have. Warns; never refuses.
shortrequiredintegerHow many components are missing.

Refusals401403404409422429

Bills of materials

What a product is made of, to read.

List the parts we make

GET/api/v1/boms

Everything whose composition is not `none`, whether or not it has a revision yet.

Example request
curl https://manufik.eu/api/v1/boms \
  -H "Authorization: Bearer mfk_…"

Answer 200

16 fields
partsrequiredobject[]
parts[].buildablerequiredstringHow many could be made from what is on hand now, sub-assemblies on the shelf used first — the plan's own figure.
parts[].compositionrequiredstring
parts[].descriptionrequiredstring
parts[].drawnrequiredbooleanWhether the released revision has a fitted line — one neither DNP nor left out of the bill of materials. An order unfolds such a product into its components; any other goes on as itself.
parts[].in_buildrequiredstringOrdered to be made: products of build orders not yet completed.
parts[].latestrequiredstring
parts[].linesrequiredintegerComponents on the latest revision.
parts[].on_handrequiredstring
parts[].orderedrequiredstringStill coming, from orders already sent.
parts[].planned_linesrequiredintegerComponents on the revision a product of a build order, the buildable quantity and the calculation read: the released one, else the newest draft. Differs from lines while a new draft is open beside a released revision.
parts[].pnrequiredstring
parts[].revisionsrequiredinteger
parts[].unitrequiredstring
parts[].materialstringWhat one costs in material — bought components at today's average, one that is out of stock at the average its last pieces left at, sub-assemblies at what making one costs. Absent for a part with no revision, for a bill of materials that contains itself, and for a role that reads neither the parts, the reports, the drawings nor the builds.
parts[].releasedstringThe released revision, if there is one. A draft is a bill of materials still being written; a released revision is what a product of a build order may consume.

Refusals401403404409422429

Valuation

What the stock is worth at a date.

Stock and its value at a date

GET/api/v1/valuation

A closed year answers from the snapshot taken when it was closed. An open one is recomputed and says so.

Example request
curl https://manufik.eu/api/v1/valuation \
  -H "Authorization: Bearer mfk_…"

Parameters

onquery · string · dateThe date to value stock at: today at the latest, by the company's own day. A later one is refused, 422 date.future.
known_atquery · stringRFC 3339. Answers 'as it was reported' rather than 'what I actually had'. The last day of a closed year is its closing snapshot as it stood then, or a replay as known then if the year had not yet been closed. Documents and allowances are read as known then; a work-in-progress record is read as it stands today, by the day it was last saved, and one removed since is not there.

Answer 200

56 fields
allowance_accountsrequiredobjectPer inventory account, where its impairment allowance sits: 112 → 191, 121 → 192, 122 → 193, 123 → 194, 132 → 196 in the standard chart. An account two classes share shows the first class's, in the order material, goods, semi-finished, finished.
allowance_by_accountrequiredobjectThe allowance per inventory account it corrects.
allowance_totalrequiredstring
as_ofrequiredstring
by_accountrequiredobjectHow the accountant reconciles it: 112 against 112, 123 against 123.
computed_atrequiredstringWhen this answer was produced. It matters for an open year.
customer_ownedrequiredobject[]Material customers supplied, held on the date, in no total of the company's stock: off-balance-sheet records, valued there at what each part says it is worth.
customer_owned[].customer_coderequiredstring
customer_owned[].customer_namerequiredstring
customer_owned[].descriptionrequiredstring
customer_owned[].pnrequiredstring
customer_owned[].qtyrequiredstring
customer_owned[].unitrequiredstring
customer_owned[].off_balance_unit_valuestringWhat one is worth in the off-balance-sheet records, as the part says: the customer's contract or delivery note. Absent when nobody said.
customer_owned[].off_balance_valuestringThe quantity at that value, to the haléř. Absent when the part has no value said. In no total of the company's stock.
from_snapshotrequiredbooleanA closed year answers from the record, not from a recomputation.
linesrequiredobject[]
lines[].accountrequiredstring112 for material, 123 for finished products. It comes from the part.
lines[].allowancerequiredstringThe impairment allowance in force on the date. Not taken off value.
lines[].averagerequiredstring
lines[].descriptionrequiredstring
lines[].in_production_qtyrequiredstring
lines[].in_production_valuerequiredstring
lines[].netrequiredstringValue less the allowance: what the balance sheet shows.
lines[].pnrequiredstring
lines[].qtyrequiredstring
lines[].valuerequiredstring
lines[].heldobject[]What of qty and value sat at warehouses a third party holds — inside qty and value, each on its warehouse's account. by_account counts it there.
lines[].held[].accountrequiredstringThe warehouse's analytic account for the part's class, or the part's own when it names none.
lines[].held[].holderrequiredstringWho held it.
lines[].held[].qtyrequiredstring
lines[].held[].valuerequiredstring
lines[].held[].warehouserequiredstringThe held warehouse's code.
lines[].held[].warehouse_namerequiredstring
net_by_accountrequiredobjectBy account, less the allowance against each.
net_totalrequiredstringTotal less every allowance.
off_balance_totalrequiredstringWhat the customers' material held on the date is worth in the off-balance-sheet records: the sum of the lines with a value said. Never in the total of the company's stock.
off_balance_unvaluedrequiredintegerLines of customers' material whose part has no value for the off-balance-sheet records.
provisionalrequiredbooleanThe year is open: a later back-dated document can still change this.
totalrequiredstring
wiprequiredobject[]Work in progress on the date, per order. Its material is not in lines; its value is in the total and by account.
wip[].accountrequiredstring
wip[].allowancerequiredstringThe impairment allowance the order's record carries, as much as counts. Not taken off value.
wip[].descriptionrequiredstring
wip[].labourrequiredstring
wip[].materialrequiredstring
wip[].netrequiredstringValue less the allowance.
wip[].order_idrequiredstring
wip[].overrequiredbooleanThe order's record says more of a component was in production than the part held on the date. The material here is what the part held, and the record wants correcting.
wip[].overheadrequiredstring
wip[].pnrequiredstring
wip[].qtyrequiredstringThe order's quantity.
wip[].servicesrequiredstring
wip[].valuerequiredstring
wip[].holderstring
wip[].warehousestringThe warehouse a third party held where the work was; account is its analytic account when it names one.

Refusals401403404409422429

Stock turnover

Opening, in, out, revaluation and closing per part over a period.

Opening, in, out, revaluation and closing per part over a period

GET/api/v1/turnover

Quantities and values from the stored costs, net of returns; a part the customer owns is never valued and is counted apart. A closed period's figures are worked out from the movements; the valuation at a date reads the closing snapshot instead.

Example request
curl https://manufik.eu/api/v1/turnover \
  -H "Authorization: Bearer mfk_…"

Parameters

fromquery · string · dateThe first day. Default the first of this month.
toquery · string · dateThe last day. Default today.

Answer 200

32 fields
classesrequiredobject[]The same summed by class of stock, every class that has a line: the exact values summed and rounded once, so the lines, each rounded, may differ from it by a few hundredths. The revaluation is worked out from the other four, as on a line.
classes[].classrequiredstringmaterialgoodssemiproduct
classes[].closing_valuerequiredstring
classes[].in_valuerequiredstring
classes[].opening_valuerequiredstring
classes[].out_valuerequiredstring
classes[].revaluationrequiredstring
customer_ownedrequiredintegerParts the customer owns that moved or are held: never valued, so not here.
fromrequiredstring · date
linesrequiredobject[]Every part with stock at either end or a movement between, by number.
lines[].accountrequiredstring
lines[].classrequiredstringmaterialgoodssemiproduct
lines[].closing_qtyrequiredstring
lines[].closing_valuerequiredstring
lines[].descriptionrequiredstring
lines[].in_qtyrequiredstringReceived, opened, made and counted over, less what went back to a vendor.
lines[].in_valuerequiredstring
lines[].opening_qtyrequiredstring
lines[].opening_valuerequiredstring
lines[].out_qtyrequiredstringIssued, used in production, scrapped and counted short, less what came back from production or a customer. Positive.
lines[].out_valuerequiredstringPositive.
lines[].pnrequiredstring
lines[].revaluationrequiredstringRevaluations and price adjustments: what the value did without a quantity moving. The rounding of the other four lands here too, so the line adds up as printed.
lines[].unitrequiredstring
torequiredstring · date
totalrequiredobjectEverything, summed as a class is; its class is empty.
total.classrequiredstringmaterialgoodssemiproduct
total.closing_valuerequiredstring
total.in_valuerequiredstring
total.opening_valuerequiredstring
total.out_valuerequiredstring
total.revaluationrequiredstring

Refusals401403404409422429

Events

What happened, in order — the feed a webhook is sent.

What happened in the company, in order, after an event already seen

GET/api/v1/events

The feed a webhook is sent, to be asked instead: thin events, oldest first, kept thirty days. Only events about what the caller's role may read. Keep the id of the last event seen and ask for what came after it.

Example request
curl https://manufik.eu/api/v1/events \
  -H "Authorization: Bearer mfk_…"

Parameters

afterquery · stringThe id of the last event already seen. Empty is from the oldest kept.
typequery · stringComma-separated types. Empty is every type the key's role may read.
limitquery · integer

Answer 200

6 fields
eventsrequiredobject[]
events[].atrequiredstring · date-time
events[].idrequiredintegerRising within a company, in the order things happened. What to ask the feed for the events after.
events[].subjectrequiredWhat it is about, as the API names it: a document's id and number, a part's number. Read the rest with the key.
events[].typerequiredstringWhat happened: document.posted, part.changed, …
nextstringPresent when there is more: ask again with after set to this.

Refusals401403404409422429

Units

The units of measure a part can have.

The units a quantity may be counted in

GET/api/v1/units

A controlled list, the same in every company, so that g, gram, gramy and G do not become four units.

Example request
curl https://manufik.eu/api/v1/units \
  -H "Authorization: Bearer mfk_…"

Answer 200

4 fields
unitsrequiredobject[]
units[].coderequiredstring
units[].countablerequiredboolean
units[].namerequiredstring

Refusals401403404409422429

Reasons

Why stock was scrapped or adjusted: the list a document picks from.

The reasons a document may give

GET/api/v1/reasons

Read off the chart of accounts, because a reason nothing maps stops a handover rather than labelling one. Narrow with the type query to what a particular kind of document may say.

Example request
curl https://manufik.eu/api/v1/reasons \
  -H "Authorization: Bearer mfk_…"

Parameters

typequery · stringA document type: scrap, stocktake, revaluation, issue or receipt. Empty is every reason the chart knows.

Answer 200

9 fields
reasonsrequiredobject[]
reasons[].coderequiredstring
reasons[].entertainmentrequiredbooleanIn a Czech company, an issue under this reason posts to representation costs, 513: a VAT payer's deduction on the stock is adjusted, or it is a supply.
reasons[].eventrequiredstringThe movement kind this reason is mapped for.
reasons[].gift_limitrequiredbooleanAn issue under this reason gives things away for the business: a piece valued over the country's limit is possibly a supply and not a tax expense.
reasons[].labelrequiredstringThe reason as a document says it: the code. The note on the mapping is note.
reasons[].requires_disposal_recordrequiredbooleanA scrap under this reason is not posted without a disposal record — on any row of the reason, for any class.
reasons[].taxable_supplyrequiredbooleanAn issue under this reason is a possible taxable supply when the company is VAT registered.
reasons[].notestringThe accountant's note on the chart's row for this reason, when it has one: an explanation, not a name.

Refusals401403404409422429