Skip to content

Sales Namespace

Sales namespace provides sales-focused access to invoices, addresses, and items.

Base Path: /sales
Access Level: Sales-focused access

Overview

The Sales namespace exposes JSON routes under /sales for invoices, addresses, items, comments, and nested invoice lines. It is aimed at sales workflows while reusing the same invoice JSON shapes as Admin Invoices.

Key Features

  • Routes: Dashboard, invoices, nested /sales/invoices/:id/invoice_lines, addresses, items, comments (see links below).
  • Invoice list: GET /sales/invoices.json returns only rows visible for the current sales session; see Sales Invoices for query params and behavior.
  • Session: Use cookie (or documented token) authentication like other namespaces; handle 403 / empty lists when the user lacks access.

Resources

Invoices

InvoicesGET/POST /sales/invoices.json, GET/PATCH/DELETE /sales/invoices/:id.json, member routes as documented.

Addresses

Customer and business partner management for sales operations.

Items

Product and inventory management for sales operations.

Comments

Comment management for sales resources.

Namespace-Specific Behavior

  • GET /sales/invoices.json is filtered for the sales workspace; not every invoice in the tenant appears here. Compare with GET /admin/invoices.json when building admin-style tools.
  • Nested lines always use /sales/invoices/:invoice_id/invoice_lines (and line id for show/update/delete), not undocumented URL patterns.

Released under an open source license.