Delivery Notes

Retrieve delivery note stats

Return aggregated KPIs for your delivery notes: total count, accumulated amount, per-status breakdown, count pending signature, and count converted to invoice this month.

get/companies/{company}/delivery-notes/stats

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/delivery-notes/stats
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "total_count": 87,
    "total_amount": "64210.50",
    "by_status": {
      "draft": {
        "status": "draft",
        "count": 12,
        "total": "8400.00"
      },
      "delivered": {
        "status": "delivered",
        "count": 58,
        "total": "41250.50"
      },
      "invoiced": {
        "status": "invoiced",
        "count": 14,
        "total": "13560.00"
      },
      "cancelled": {
        "status": "cancelled",
        "count": 3,
        "total": "1000.00"
      }
    },
    "pending_signature": 21,
    "converted_this_month": 6
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.