N1Developer docsv1

Dashboard · v1

QUERY

dashboard

Mock

Mock. This operation is part of the approved contract but its module is not built yet. Run Core with N1_API_MODE=mock N1_DEV_AUTH=stub to get deterministic demo-shop data from it. The real server answers NOT_IMPLEMENTED until it ships; the schema and examples here will not change when it does.

One query fills the owner dashboard for the selected period

Try this operation →Use Postman ↗

Whole owner/admin dashboard for WEEK, MONTH or YEAR; mock until N1C-065 read model ships.

POST/graphqlapp audience

Who can call this. Owner and admin.

Headers

  • AuthorizationstringRequired

    Bearer <token>, issued for this endpoint's audience. The token decides the shop and roles; nothing in the request body can change them.

    Example: Bearer eyJhbGciOiJFZERTQSJ9…

  • Content-TypestringRequired

    Always application/json. Only POST is accepted.

    Example: application/json

  • X-Request-IdstringOptional

    Your id for this request (8–128 characters of A–Z a–z 0–9 . _ : -). Echoed back in the response header and in every error, so you can quote it when reporting a problem. Core makes one if you send none.

    Example: app-7f3c2a9e-checkout

Arguments

  • afterStringOptional

    endCursor of the previous page.

  • beforeStringOptional

    startCursor of the next page, when paging backwards.

  • firstIntOptional

    Page size, 1–100 (default 20).

  • lastIntOptional

    Page size when paging backwards, 1–100.

  • periodDashboardPeriod!Required

    Business period.

    Example: "WEEK"

    • MONTHCalendar month to date.
    • WEEKTrailing seven calendar days including today.
    • YEARCalendar year to date.
  • priorityAfterStringOptional

    Previous priorityJobs endCursor.

  • priorityFirstIntOptional

    Priority job page size, default 20.

Returns

  • dashboardDashboard!Required

    Whole owner/admin dashboard for WEEK, MONTH or YEAR; mock until N1C-065 read model ships.

    Show children
    • billedFloat!Required

      Billed during the period, integer paise.

      Example: 2800000

    • customerDistributionCustomerDistributionConnection!Required

      Customer shares, ordered by name and id.

      Example: {"totalCount":7,"pageInfo":{"hasNextPage":true,"endCursor":"WyJlYXN0ZXJuIGVuZ2luZWVyaW5nIDUiLCIwMTkyZjBjMS0wMDAwLTcwMDAtODAwMC0wMDAwMDAwYzAwMDUiXQ"},"edges":[{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0001","name":"Alpha Auto Components 1","orders":1,"percent":14.285714285714286,"totalRevenue":100000,"outstandingBalance":25000,"pendingDelivery":1}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0002","name":"Bharat Hydraulics 2","orders":1,"percent":14.285714285714286,"totalRevenue":200000,"outstandingBalance":0,"pendingDelivery":1}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0003","name":"Cauvery Pumps 3","orders":1,"percent":14.285714285714286,"totalRevenue":300000,"outstandingBalance":0,"pendingDelivery":0}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0004","name":"Deccan Fasteners 4","orders":1,"percent":14.285714285714286,"totalRevenue":400000,"outstandingBalance":100000,"pendingDelivery":1}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0005","name":"Eastern Engineering 5","orders":1,"percent":14.285714285714286,"totalRevenue":500000,"outstandingBalance":0,"pendingDelivery":1}}]}

      Show children
      • edges[CustomerDistributionEdge!]!Required

        The rows on this page, in order.

        Example: [{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0001","name":"Alpha Auto Components 1","orders":1,"percent":14.285714285714286,"totalRevenue":100000,"outstandingBalance":25000,"pendingDelivery":1}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0002","name":"Bharat Hydraulics 2","orders":1,"percent":14.285714285714286,"totalRevenue":200000,"outstandingBalance":0,"pendingDelivery":1}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0003","name":"Cauvery Pumps 3","orders":1,"percent":14.285714285714286,"totalRevenue":300000,"outstandingBalance":0,"pendingDelivery":0}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0004","name":"Deccan Fasteners 4","orders":1,"percent":14.285714285714286,"totalRevenue":400000,"outstandingBalance":100000,"pendingDelivery":1}},{"node":{"id":"0192f0c1-0000-7000-8000-0000000c0005","name":"Eastern Engineering 5","orders":1,"percent":14.285714285714286,"totalRevenue":500000,"outstandingBalance":0,"pendingDelivery":1}}]

        Show children
        • cursorString!Required

          Opaque position of this row in the list.

        • nodeCustomerDistribution!Required

          The CustomerDistribution.

          Example: {"id":"0192f0c1-0000-7000-8000-0000000c0001","name":"Alpha Auto Components 1","orders":1,"percent":14.285714285714286,"totalRevenue":100000,"outstandingBalance":25000,"pendingDelivery":1}

          Show children
          • idID!Required

            Customer id.

            Example: "0192f0c1-0000-7000-8000-0000000c0001"

          • nameString!Required

            Customer name.

            Example: "Alpha Auto Components 1"

          • ordersInt!Required

            Orders in the selected period.

            Example: 1

          • outstandingBalanceFloat!Required

            Outstanding on selected-period orders, integer paise.

            Example: 25000

          • pendingDeliveryInt!Required

            Selected-period orders with unfinished production.

            Example: 1

          • percentFloat!Required

            Share of selected-period order count, 0–100; zero when empty.

            Example: 14.285714285714286

          • totalRevenueFloat!Required

            Selected-period billed revenue in integer paise.

            Example: 100000

      • pageInfoPageInfo!Required

        Whether more pages exist, and the cursors to reach them.

        Example: {"hasNextPage":true,"endCursor":"WyJlYXN0ZXJuIGVuZ2luZWVyaW5nIDUiLCIwMTkyZjBjMS0wMDAwLTcwMDAtODAwMC0wMDAwMDAwYzAwMDUiXQ"}

        Show children
        • endCursorStringOptional

          Cursor of the last row; pass it as after to get the next page. Null when the page is empty.

          Example: "WyJlYXN0ZXJuIGVuZ2luZWVyaW5nIDUiLCIwMTkyZjBjMS0wMDAwLTcwMDAtODAwMC0wMDAwMDAwYzAwMDUiXQ"

        • hasNextPageBoolean!Required

          Whether another page follows this one.

          Example: true

        • hasPreviousPageBoolean!Required

          Whether another page comes before this one.

        • startCursorStringOptional

          Cursor of the first row; pass it as before to page backwards. Null when the page is empty.

      • totalCountInt!Required

        All rows matching the filter and search, not just this page.

        Example: 7

    • fromString!Required

      Inclusive business date, YYYY-MM-DD.

      Example: "2026-10-06"

    • ordersInt!Required

      Period order count.

      Example: 7

    • outstandingFloat!Required

      All current unpaid balances, integer paise; independent of period.

      Example: 2300000

    • periodDashboardPeriod!Required

      Selected period.

      Example: "WEEK"

      • MONTHCalendar month to date.
      • WEEKTrailing seven calendar days including today.
      • YEARCalendar year to date.
    • priorityJobsPriorityJobConnection!Required

      Open priority jobs, soonest due first, across all periods.

      Example: {"totalCount":15,"pageInfo":{"hasNextPage":true,"endCursor":"WyIyMDI2LTEwLTEwIiwiMDE5MmYwYzEtMDAwMC03MDAwLTgwMDAtMDAwMDAwZDIwMDNkIl0"},"edges":[{"node":{"id":"0192f0c1-0000-7000-8000-000000d2000b","routeCardNo":"RC-PO-2026-0001","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2000b","qrValue":"JC-00001","orderId":"0192f0c1-0000-7000-8000-000000d00001","part":"Bush 25x30","quantity":40,"customerName":"Alpha Auto Components 1","dueDate":"2026-09-30","status":"IN_PROGRESS","operations":[{"name":"Threading","status":"DONE","operatorName":"Esha Demo","machineName":null},{"name":"Milling","status":"RUNNING","operatorName":"Esha Demo","machineName":"Lathe 1"},{"name":"Finishing","status":"PENDING","operatorName":"Esha Demo","machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d2000c","routeCardNo":"RC-PO-2026-0001","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2000c","qrValue":"JC-00002","orderId":"0192f0c1-0000-7000-8000-000000d00001","part":"Pulley 90","quantity":60,"customerName":"Alpha Auto Components 1","dueDate":"2026-09-30","status":"IN_PROGRESS","operations":[{"name":"Turning","status":"DONE","operatorName":"Farid Demo","machineName":null},{"name":"Deburring","status":"RUNNING","operatorName":"Farid Demo","machineName":"Lathe 2"},{"name":"Finishing","status":"PENDING","operatorName":"Farid Demo","machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d20029","routeCardNo":"RC-PO-2026-0004","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d20029","qrValue":"JC-00007","orderId":"0192f0c1-0000-7000-8000-000000d00004","part":"Valve Body","quantity":100,"customerName":"Deccan Fasteners 4","dueDate":"2026-10-06","status":"QUEUED","operations":[{"name":"Threading","status":"PENDING","operatorName":"Esha Demo","machineName":null},{"name":"Deburring","status":"PENDING","operatorName":null,"machineName":null},{"name":"Finishing","status":"PENDING","operatorName":null,"machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d2002a","routeCardNo":"RC-PO-2026-0004","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2002a","qrValue":"JC-00008","orderId":"0192f0c1-0000-7000-8000-000000d00004","part":"Coupling Hub","quantity":180,"customerName":"Deccan Fasteners 4","dueDate":"2026-10-06","status":"IN_PROGRESS","operations":[{"name":"Turning","status":"DONE","operatorName":"Esha Demo","machineName":null},{"name":"Milling","status":"RUNNING","operatorName":"Esha Demo","machineName":"Mill 1"},{"name":"Finishing","status":"PENDING","operatorName":"Esha Demo","machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d2003d","routeCardNo":"RC-PO-2026-0006","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2003d","qrValue":"JC-00012","orderId":"0192f0c1-0000-7000-8000-000000d00006","part":"Gear Blank 64T","quantity":140,"customerName":"Falcon Tooling 6","dueDate":"2026-10-10","status":"IN_PROGRESS","operations":[{"name":"Drilling","status":"DONE","operatorName":"Farid Demo","machineName":null},{"name":"Deburring","status":"RUNNING","operatorName":"Farid Demo","machineName":null},{"name":"Finishing","status":"PENDING","operatorName":"Farid Demo","machineName":null}]}}}]}

      Show children
      • edges[PriorityJobEdge!]!Required

        The rows on this page, in order.

        Example: [{"node":{"id":"0192f0c1-0000-7000-8000-000000d2000b","routeCardNo":"RC-PO-2026-0001","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2000b","qrValue":"JC-00001","orderId":"0192f0c1-0000-7000-8000-000000d00001","part":"Bush 25x30","quantity":40,"customerName":"Alpha Auto Components 1","dueDate":"2026-09-30","status":"IN_PROGRESS","operations":[{"name":"Threading","status":"DONE","operatorName":"Esha Demo","machineName":null},{"name":"Milling","status":"RUNNING","operatorName":"Esha Demo","machineName":"Lathe 1"},{"name":"Finishing","status":"PENDING","operatorName":"Esha Demo","machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d2000c","routeCardNo":"RC-PO-2026-0001","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2000c","qrValue":"JC-00002","orderId":"0192f0c1-0000-7000-8000-000000d00001","part":"Pulley 90","quantity":60,"customerName":"Alpha Auto Components 1","dueDate":"2026-09-30","status":"IN_PROGRESS","operations":[{"name":"Turning","status":"DONE","operatorName":"Farid Demo","machineName":null},{"name":"Deburring","status":"RUNNING","operatorName":"Farid Demo","machineName":"Lathe 2"},{"name":"Finishing","status":"PENDING","operatorName":"Farid Demo","machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d20029","routeCardNo":"RC-PO-2026-0004","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d20029","qrValue":"JC-00007","orderId":"0192f0c1-0000-7000-8000-000000d00004","part":"Valve Body","quantity":100,"customerName":"Deccan Fasteners 4","dueDate":"2026-10-06","status":"QUEUED","operations":[{"name":"Threading","status":"PENDING","operatorName":"Esha Demo","machineName":null},{"name":"Deburring","status":"PENDING","operatorName":null,"machineName":null},{"name":"Finishing","status":"PENDING","operatorName":null,"machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d2002a","routeCardNo":"RC-PO-2026-0004","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2002a","qrValue":"JC-00008","orderId":"0192f0c1-0000-7000-8000-000000d00004","part":"Coupling Hub","quantity":180,"customerName":"Deccan Fasteners 4","dueDate":"2026-10-06","status":"IN_PROGRESS","operations":[{"name":"Turning","status":"DONE","operatorName":"Esha Demo","machineName":null},{"name":"Milling","status":"RUNNING","operatorName":"Esha Demo","machineName":"Mill 1"},{"name":"Finishing","status":"PENDING","operatorName":"Esha Demo","machineName":null}]}}},{"node":{"id":"0192f0c1-0000-7000-8000-000000d2003d","routeCardNo":"RC-PO-2026-0006","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2003d","qrValue":"JC-00012","orderId":"0192f0c1-0000-7000-8000-000000d00006","part":"Gear Blank 64T","quantity":140,"customerName":"Falcon Tooling 6","dueDate":"2026-10-10","status":"IN_PROGRESS","operations":[{"name":"Drilling","status":"DONE","operatorName":"Farid Demo","machineName":null},{"name":"Deburring","status":"RUNNING","operatorName":"Farid Demo","machineName":null},{"name":"Finishing","status":"PENDING","operatorName":"Farid Demo","machineName":null}]}}}]

        Show children
        • cursorString!Required

          Opaque position of this row in the list.

        • nodePriorityJob!Required

          The PriorityJob.

          Example: {"id":"0192f0c1-0000-7000-8000-000000d2000b","routeCardNo":"RC-PO-2026-0001","jobCard":{"id":"0192f0c1-0000-7000-8000-000000d2000b","qrValue":"JC-00001","orderId":"0192f0c1-0000-7000-8000-000000d00001","part":"Bush 25x30","quantity":40,"customerName":"Alpha Auto Components 1","dueDate":"2026-09-30","status":"IN_PROGRESS","operations":[{"name":"Threading","status":"DONE","operatorName":"Esha Demo","machineName":null},{"name":"Milling","status":"RUNNING","operatorName":"Esha Demo","machineName":"Lathe 1"},{"name":"Finishing","status":"PENDING","operatorName":"Esha Demo","machineName":null}]}}

          Show children
          • idID!Required

            Job card id.

            Example: "0192f0c1-0000-7000-8000-000000d2000b"

          • jobCardJobCard!Required

            Complete job card for the priority card.

            Example: {"id":"0192f0c1-0000-7000-8000-000000d2000b","qrValue":"JC-00001","orderId":"0192f0c1-0000-7000-8000-000000d00001","part":"Bush 25x30","quantity":40,"customerName":"Alpha Auto Components 1","dueDate":"2026-09-30","status":"IN_PROGRESS","operations":[{"name":"Threading","status":"DONE","operatorName":"Esha Demo","machineName":null},{"name":"Milling","status":"RUNNING","operatorName":"Esha Demo","machineName":"Lathe 1"},{"name":"Finishing","status":"PENDING","operatorName":"Esha Demo","machineName":null}]}

          • routeCardNoString!Required

            Route card reference.

            Example: "RC-PO-2026-0001"

      • pageInfoPageInfo!Required

        Whether more pages exist, and the cursors to reach them.

        Example: {"hasNextPage":true,"endCursor":"WyIyMDI2LTEwLTEwIiwiMDE5MmYwYzEtMDAwMC03MDAwLTgwMDAtMDAwMDAwZDIwMDNkIl0"}

        Show children
        • endCursorStringOptional

          Cursor of the last row; pass it as after to get the next page. Null when the page is empty.

          Example: "WyIyMDI2LTEwLTEwIiwiMDE5MmYwYzEtMDAwMC03MDAwLTgwMDAtMDAwMDAwZDIwMDNkIl0"

        • hasNextPageBoolean!Required

          Whether another page follows this one.

          Example: true

        • hasPreviousPageBoolean!Required

          Whether another page comes before this one.

        • startCursorStringOptional

          Cursor of the first row; pass it as before to page backwards. Null when the page is empty.

      • totalCountInt!Required

        All rows matching the filter and search, not just this page.

        Example: 15

    • toString!Required

      Inclusive business date, YYYY-MM-DD.

      Example: "2026-10-12"

    • updatedAtString!Required

      Read-model freshness, UTC ISO timestamp.

      Example: "2026-10-12T04:30:00.000Z"

Errors

This operation has no documented error responses.

Every error has the same body. See Errors.

Rate limit tier

Tier: per user. Over the limit you get RATE_LIMITED (HTTP 429) with a Retry-After header. See Response handling.

Search documentation

Search operations, types and errors from the generated contract.

↑ ↓ to navigate · Enter to openEsc to close