Changelog
All entries are compatible additions within version 1: new optional fields, new entity types and new values. Implementations that follow the compatibility rules keep working across them.
Specification, October 2026
Section titled “Specification, October 2026”- Documentation site with the complete specification, generated API reference and test vectors.
- Documented fields the reference app already writes:
created_atonarticle,locationandrecipient;items[].barcodeondelivery_note. - Marked
document_template.numbering.nextas reserved: the reference app keeps the device counter on the device. - JSON Schemas now describe what a conforming writer sends, including the fields the reference app needs to show a record, defaults and examples; the reference server's rules are listed separately per entity.
- OpenAPI description: every response status the reference server emits, reusable error responses, headers (
Content-Language, rate limit headers), the snapshot cursor, and request examples.
Protocol additions in version 1
Section titled “Protocol additions in version 1”| Addition | Fields |
|---|---|
| Handover conditions set and locked by the organisation | document_template.jurisdiction, document_template.locked, push rejection reason locked |
| Accessories of articles and lent items | article.accessories, loan.items[].accessories, loan.returns[].items[].accessories, loan.returns[].items[].lost_accessories |
| Condition photos on loans | loan.items[].photos, loan.returns[].items[].photos |
| Loans, employees as recipients, late-return penalties | entity loan, movement.loan_id, recipient.kind value employee, recipient.department, document_template kind loan with terms, employee_terms, penalty_enabled, penalty |
| Prices and the inventory currency | article.purchase_price, article.sale_price, company_profile.currency |
| Archiving | archived on article, location, recipient |
| Initial release | entities article, location, recipient, movement, delivery_note, company_profile, document_template; discovery, authentication, push, pull, attachments, number ranges, organisation licence |