# OpenBusinessAPI (OBAPI)

> OBAPI is an open standard REST API for B2B document exchange -- invoices, orders, proposals and more

OBAPI defines a unified REST API so any compatible provider can expose its business documents (invoices, orders, proposals, and more) through one standard interface. This file is a curated map of the specification for AI agents and tools: fetch the linked pages, or grab the whole spec at once from https://obapi.org/llms-full.txt.

The OpenAPI document at https://obapi.org/assets/openapi.yaml is the machine-readable source of truth for endpoints, request and response schemas.

## Guides

- [For AI Agents](https://obapi.org/v1/for-ai-agents): OBAPI is designed to be implemented with the help of an AI coding assistant. The whole specification is exposed as machine-readable, single-URL entry points so you can hand an agent one link and let it do the work.
- [Workflows](https://obapi.org/v1/workflows): Understanding how OBAPI objects relate to each other and how documents flow through their lifecycle.
- [Getting Started](https://obapi.org/v1/getting-started): Get your first OBAPI response in 5 minutes.

## Transversal

- [Authentication](https://obapi.org/v1/auth): Authentication is done via Bearer token. The enrollment process (how you obtain the token) is outside the scope of OBAPI -- each provider decides: login/password with JWT, pre-shared key, OAuth2, etc.
- [Discovery](https://obapi.org/v1/discovery): The discovery endpoint lets a client know which objects and capabilities a given OBAPI server supports. Not every server will implement all tiers.
- [Errors](https://obapi.org/v1/errors): OBAPI uses conventional HTTP response codes and a structured JSON error body.

## Tier 1 -- Core

- [Thirdparty](https://obapi.org/v1/thirdparty): The provider's identity. Unlike other objects, this endpoint is singular -- it returns who owns this OBAPI server.
- [Contacts](https://obapi.org/v1/contacts): Contact persons associated with the provider.
- [Products](https://obapi.org/v1/products): Product and service catalog.
- [Proposals](https://obapi.org/v1/proposals): Sales quotation / devis.
- [Orders](https://obapi.org/v1/orders): Customer orders.
- [Invoices](https://obapi.org/v1/invoices): Customer invoices. This is the original and primary OBAPI use case.
- [Credit Notes](https://obapi.org/v1/creditnotes): Credit note / avoir. Same structure as Invoice with type always set to creditnote.
- [Shipments](https://obapi.org/v1/shipments): Delivery / despatch advice. Represents goods shipped to the customer.
- [Download](https://obapi.org/v1/download): Generic document download. Returns the binary PDF for any OBAPI object.

## Tier 2 -- Extended

- [Supplier Proposals](https://obapi.org/v1/supplier-proposals): Request for quotation / price request sent to a supplier.
- [Supplier Orders](https://obapi.org/v1/supplier-orders): Purchase orders sent to suppliers.
- [Supplier Invoices](https://obapi.org/v1/supplier-invoices): Invoices received from suppliers.
- [Receptions](https://obapi.org/v1/receptions): Goods received from a supplier (receipt advice). The counterpart of shipments on the purchasing side.
- [Contracts](https://obapi.org/v1/contracts): Service contracts and subscription agreements.
- [Interventions](https://obapi.org/v1/interventions): Service intervention reports. Records on-site or remote work performed for a customer.
- [Tickets](https://obapi.org/v1/tickets): Support tickets for customer service and helpdesk.
- [Usage & Metering](https://obapi.org/v1/usage): Usage-based billing metrics for hosted services.

## Tier 3 -- Advanced

- [Projects](https://obapi.org/v1/projects): Shared project tracking between entities.
- [Tasks](https://obapi.org/v1/tasks): Project tasks. A task always belongs to a project.
- [Expense Reports](https://obapi.org/v1/expense-reports): Employee expense claims.
- [BOMs](https://obapi.org/v1/boms): Bill of materials for manufacturing. Describes the components needed to produce a finished product.
- [Manufacturing Orders](https://obapi.org/v1/manufacturing-orders): Production runs based on a Bill of Materials.
- [Warehouses](https://obapi.org/v1/warehouses): Stock locations and storage facilities.
- [Members](https://obapi.org/v1/members): Association and cooperative members.
- [Categories](https://obapi.org/v1/categories): Shared classification and tagging system. Categories can be applied to multiple object types.

## Other

- [Demonstration](https://obapi.org/v1/demo): An OBAPI server built on Dolibarr ERP, queried by a simple PHP command-line client:
- [API Explorer](https://obapi.org/v1/explorer): Interactive reference generated from the OpenAPI specification.

## Reference

- [OpenAPI specification (YAML)](https://obapi.org/assets/openapi.yaml): Complete machine-readable API contract (source of truth)
- [Full specification, single file](https://obapi.org/llms-full.txt): Every page above concatenated into one document for one-shot ingestion