Invoices

What you billed your customers, read-only.

sales:readhttps://public-api.nutrasoft.ca/v1

Links toSales orderssales_order_id Customerscustomer_id Productslines[].product_id

The Invoice object

idinteger
billing_addressobject
ShowHide 5 fields of billing_address
- citystringnullable
- line1stringnullable
- line2stringnullable
- postal_codestringnullable
- statestringnullable
cancelled_atstringnullable
- date YYYY-MM-DD
companystringnullable
created_atstringnullable
- UTC timestamp
customer_idintegernullable
invoice_nointegernullable
is_cancelledboolean
A cancelled invoice is kept, never deleted.
linesarray of objectsnullable
On a single invoice; null on the list.
ShowHide 11 fields of lines
- idinteger
- discount_ratenumbernullable
  Percent off this line. Requires cost:read.
- pricenumbernullable
  Per uom_type unit. Requires cost:read.
- product_codestringnullable
- product_idintegernullable
- product_namestringnullable
- shipped_qtynumbernullable
  Shipped, in uom_type units.
- shipped_qty_basenumbernullable
  Shipped, in the product's base unit.
- tax1booleannullable
  Whether tax 1 applies to this line. Requires cost:read.
- tax2booleannullable
  Whether tax 2 applies to this line. Requires cost:read.
- uom_typestringnullable
  The unit shipped_qty and price are in.
  - one ofINVENTORY_UNITPACKAGING_SIZEBASE_UOM
order_datestringnullable
- date YYYY-MM-DD

Show 10 more attributes

paid_amountnumbernullable
Requires cost:read.
sales_order_idintegernullable
ship_datestringnullable
- date YYYY-MM-DD
shipping_addressobject
ShowHide 5 fields of shipping_address
- citystringnullable
- line1stringnullable
- line2stringnullable
- postal_codestringnullable
- statestringnullable
subtotalnumbernullable
Sum of the lines after line discounts, before tax. Requires cost:read; null means redacted, not zero.
tax1booleannullable
Whether tax 1 applies to this document. Requires cost:read; null means redacted, not false.
tax1_ratenumbernullable
Tax 1 percentage, e.g. 5.0 for 5%. Requires cost:read.
tax2booleannullable
Whether tax 2 applies to this document. Requires cost:read; null means redacted, not false.
tax2_ratenumbernullable
Tax 2 percentage, e.g. 5.0 for 5%. Requires cost:read.
updated_atstringnullable
- UTC timestamp

Operations

List invoices

get/invoicessales:read

Read-only: shipping produces invoices. Use search or the named filters, not both. Money fields require cost:read.

Query parameters

customer_idintegernullable
- > 0
sales_order_idintegernullable
- > 0
invoice_date_fromstringnullable
- date YYYY-MM-DD
invoice_date_tostringnullable
- date YYYY-MM-DD
searchstringnullable
Free-text match.
sortstringnullable
Comma-separated field:direction pairs, e.g. id:desc. Sortable: created_at, id, invoice_no, order_date, ship_date, updated_at. id is always added last, so paging is stable.
limitinteger
Rows to return. Maximum 200.
- >= 1
- <= 200
- default 50
offsetinteger
Rows to skip. Maximum 10000: to read further, narrow the filters or page with updated_since.
- >= 0
- <= 10000
- default 0
updated_sincestringnullable
Only rows changed after this instant, as an ISO 8601 timestamp; without an offset it is read as UTC. Tracks the record itself, not its child rows, and deletions are not reported, so reconcile by re-listing from time to time.
- UTC timestamp

Returns

200 A page of Invoice objects in data, with pagination.

Errors

400 401 403 429 500 503

GET /invoices

curl "https://public-api.nutrasoft.ca/v1/invoices?limit=50" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": [
    {
      "id": 123,
      "billing_address": {
        "city": "Montreal",
        "line1": "123 Example Street",
        "line2": "Suite 200",
        "postal_code": "H4S 2C1",
        "state": "QC"
      },
      "cancelled_at": "2026-09-10",
      "company": "Example Foods Inc.",
      "created_at": "2026-09-10T14:30:00Z",
      "customer_id": 123,
      "invoice_no": 10,
      "is_cancelled": false,
      "lines": null,
      "order_date": "2026-09-10",
      "paid_amount": 12.5,
      "sales_order_id": 123,
      "ship_date": "2026-09-10",
      "shipping_address": {
        "city": "Montreal",
        "line1": "123 Example Street",
        "line2": "Suite 200",
        "postal_code": "H4S 2C1",
        "state": "QC"
      },
      "subtotal": 12.5,
      "tax1": false,
      "tax1_rate": 12.5,
      "tax2": false,
      "tax2_rate": 12.5,
      "updated_at": "2026-09-10T14:30:00Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  },
  "order": "id:asc"
}

Retrieve an invoice

get/invoices/{invoice_id}sales:read

Path parameters

invoice_idintegerrequired
The invoice's id.
- > 0

Returns

200 One Invoice object in data.

Errors

400 401 403 404 429 500 503

GET /invoices/{invoice_id}

curl "https://public-api.nutrasoft.ca/v1/invoices/123" \
  -H "Authorization: Bearer $NUTRASOFT_API_KEY"

Response200

{
  "data": {
    "id": 123,
    "billing_address": {
      "city": "Montreal",
      "line1": "123 Example Street",
      "line2": "Suite 200",
      "postal_code": "H4S 2C1",
      "state": "QC"
    },
    "cancelled_at": "2026-09-10",
    "company": "Example Foods Inc.",
    "created_at": "2026-09-10T14:30:00Z",
    "customer_id": 123,
    "invoice_no": 10,
    "is_cancelled": false,
    "lines": [
      {
        "id": 123,
        "discount_rate": 12.5,
        "price": 12.5,
        "product_code": "SAMPLE-01",
        "product_id": 123,
        "product_name": "Sample name",
        "shipped_qty": 12.5,
        "shipped_qty_base": 12.5,
        "tax1": false,
        "tax2": false,
        "uom_type": "INVENTORY_UNIT"
      }
    ],
    "order_date": "2026-09-10",
    "paid_amount": 12.5,
    "sales_order_id": 123,
    "ship_date": "2026-09-10",
    "shipping_address": {
      "city": "Montreal",
      "line1": "123 Example Street",
      "line2": "Suite 200",
      "postal_code": "H4S 2C1",
      "state": "QC"
    },
    "subtotal": 12.5,
    "tax1": false,
    "tax1_rate": 12.5,
    "tax2": false,
    "tax2_rate": 12.5,
    "updated_at": "2026-09-10T14:30:00Z"
  }
}