> ## Documentation Index
> Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt
> Use this file to discover all available pages before exploring further.

# Count purchase orders

> Counts the purchase orders listPurchaseOrders lists for the same filters, in all, per status and with invoices, and totals their commitment and billed amount excluding VAT per currency and converted to the organization currency, as getInvoiceMetrics does. Archived orders are left out unless archived=true.



## OpenAPI

````yaml /openapi.json get /v1/purchase-orders/metrics
openapi: 3.1.0
info:
  title: Watchdog API
  version: 1.0.0
  description: >-
    The Watchdog API is served from https://api.watchdog.no. Request bodies are
    limited to 2 MiB unless an endpoint says otherwise. Files are uploaded
    directly to storage, not through the API.
servers:
  - url: https://api.watchdog.no
    description: Watchdog API
security: []
paths:
  /v1/purchase-orders/metrics:
    get:
      tags:
        - Purchase orders
      summary: Count purchase orders
      description: >-
        Counts the purchase orders listPurchaseOrders lists for the same
        filters, in all, per status and with invoices, and totals their
        commitment and billed amount excluding VAT per currency and converted to
        the organization currency, as getInvoiceMetrics does. Archived orders
        are left out unless archived=true.
      operationId: getPurchaseOrderMetrics
      parameters:
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            The organization to act in. Required for personal API keys; list the
            organizations you can access with GET /v1/organizations.
        - name: fields
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
          description: >-
            Return only these fields; use dots for nested fields, such as
            counts.draft. Fields: total_count, counts, awaiting_approval_count,
            with_invoices_count, organization_currency, currencies.
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: Order number, the other system's number (source.number) or title.
          required: false
          description: Order number, the other system's number (source.number) or title.
          name: search
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 50
            description: Only orders linked to this other system (source.system).
          required: false
          description: Only orders linked to this other system (source.system).
          name: source_system
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
              maxLength: 200
            description: Only orders with these IDs in their other system (source.id).
          required: false
          description: Only orders with these IDs in their other system (source.id).
          style: form
          explode: false
          name: source_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - draft
                - open
                - closed
                - cancelled
          required: false
          style: form
          explode: false
          name: statuses
          in: query
        - schema:
            type: boolean
            description: >-
              true lists only orders waiting for approval, false only the
              others.
          required: false
          description: true lists only orders waiting for approval, false only the others.
          name: awaiting_approval
          in: query
        - schema:
            type: array
            items:
              type: string
              format: uuid
          required: false
          style: form
          explode: false
          name: supplier_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            maxItems: 1000
            description: Only orders these workspace companies placed.
          required: false
          description: Only orders these workspace companies placed.
          style: form
          explode: false
          name: company_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              format: uuid
            description: 'Recipient IDs: the legal entities that placed the orders.'
          required: false
          description: 'Recipient IDs: the legal entities that placed the orders.'
          style: form
          explode: false
          name: buyer_ids
          in: query
        - schema:
            type: array
            items:
              type: string
              minLength: 1
              maxLength: 200
              pattern: ^[A-Za-z0-9_-]+$
          required: false
          style: form
          explode: false
          name: owner_user_ids
          in: query
        - schema:
            type: string
            enum:
              - me
            description: >-
              me: orders the caller owns, and orders whose pending approval
              request asks the caller to approve, by name or through a team they
              are in.
          required: false
          description: >-
            me: orders the caller owns, and orders whose pending approval
            request asks the caller to approve, by name or through a team they
            are in.
          name: assigned
          in: query
        - schema:
            type: array
            items:
              type: string
          required: false
          style: form
          explode: false
          name: agreement_ids
          in: query
        - schema:
            type: boolean
            description: true lists only archived orders; by default they are left out.
          required: false
          description: true lists only archived orders; by default they are left out.
          name: archived
          in: query
        - schema:
            type: boolean
            description: >-
              true lists only orders with an accepted invoice
              (billing.linked_invoices above 0), false only those without.
          required: false
          description: >-
            true lists only orders with an accepted invoice
            (billing.linked_invoices above 0), false only those without.
          name: has_invoices
          in: query
      responses:
        '200':
          description: Purchase order counts and totals.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                total_count: 7
                counts:
                  draft: 3
                  open: 3
                  closed: 1
                  cancelled: 0
                awaiting_approval_count: 1
                with_invoices_count: 3
                organization_currency:
                  currency_code: NOK
                  commitment_amount: '250000.00'
                  billed_amount: '84210.50'
                currencies:
                  - currency_code: NOK
                    order_count: 7
                    commitment_amount: '250000.00'
                    billed_amount: '84210.50'
              schema:
                $ref: '#/components/schemas/PurchaseOrderMetrics'
        '400':
          description: >-
            The request is invalid. details lists up to 20 field errors. Request
            bodies are limited to 2 MiB.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: validation_error
                  message: >-
                    The request is invalid. details lists up to 20 field errors.
                    Request bodies are limited to 2 MiB.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_validation_error'
        '401':
          description: The bearer token is missing or invalid.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            WWW-Authenticate:
              schema:
                type: string
              required: false
              description: Bearer authentication challenge, when supplied.
          content:
            application/json:
              example:
                error:
                  code: invalid_token
                  message: The bearer token is missing or invalid.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_invalid_token'
        '403':
          description: >-
            Access denied. The error code says why: forbidden, token_disabled,
            organization_required, insufficient_role or mfa_required.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: forbidden
                  message: >-
                    Access denied. The error code says why: forbidden,
                    token_disabled, organization_required, insufficient_role or
                    mfa_required.
                  request_id: req_example
              schema:
                $ref: >-
                  #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required
        '404':
          description: The resource does not exist in the current organization.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: not_found
                  message: The resource does not exist in the current organization.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_not_found'
        '429':
          description: Too many requests. Wait for the Retry-After delay before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Wait for the Retry-After delay before
                    retrying.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_rate_limit_exceeded'
        '500':
          description: >-
            Unexpected server failure. Include the request ID when contacting
            support.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              example:
                error:
                  code: internal_error
                  message: >-
                    Unexpected server failure. Include the request ID when
                    contacting support.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_internal_error'
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After delay, when
            provided.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Temporarily unavailable. Retry after the Retry-After delay,
                    when provided.
                  request_id: req_example
              schema:
                $ref: '#/components/schemas/Error_service_unavailable'
      security:
        - ApiKeyBearer: []
components:
  schemas:
    PurchaseOrderMetrics:
      type: object
      properties:
        total_count:
          type: integer
          minimum: 0
        counts:
          type: object
          properties:
            draft:
              type: integer
              minimum: 0
            open:
              type: integer
              minimum: 0
            closed:
              type: integer
              minimum: 0
            cancelled:
              type: integer
              minimum: 0
          required:
            - draft
            - open
            - closed
            - cancelled
          description: The counted orders per status.
        awaiting_approval_count:
          type: integer
          minimum: 0
          description: >-
            Of the counted orders, those waiting for approval, whatever their
            status.
        with_invoices_count:
          type: integer
          minimum: 0
          description: >-
            Of the counted orders, those with an accepted invoice, as
            has_invoices=true.
        organization_currency:
          type: object
          properties:
            currency_code:
              type: string
            commitment_amount:
              type: string
              pattern: ^-?\d+(?:\.\d+)?$
              description: >-
                Commitment excluding VAT of the counted orders. An order without
                a commitment adds nothing.
            billed_amount:
              type: string
              pattern: ^-?\d+(?:\.\d+)?$
              description: Billed excluding VAT of the counted orders.
          required:
            - currency_code
            - commitment_amount
            - billed_amount
          description: >-
            Totals converted to the organization currency at each order's
            issued_date (its creation date when it has none), rounded to cents.
            An order without an amount or exchange rate adds nothing.
        currencies:
          type: array
          items:
            type: object
            properties:
              currency_code:
                type:
                  - string
                  - 'null'
              order_count:
                type: integer
                minimum: 0
              commitment_amount:
                type: string
                pattern: ^-?\d+(?:\.\d+)?$
                description: >-
                  Commitment excluding VAT: the sum of totals.commitment. An
                  order without a commitment (an amount-limit order without a
                  limit) adds nothing.
              billed_amount:
                type: string
                pattern: ^-?\d+(?:\.\d+)?$
                description: >-
                  Billed excluding VAT: the sum of billing.billed, in the order
                  currency.
            required:
              - currency_code
              - order_count
              - commitment_amount
              - billed_amount
          description: The counted orders per order currency, by currency code.
      required:
        - total_count
        - counts
        - awaiting_approval_count
        - with_invoices_count
        - organization_currency
        - currencies
    Error_validation_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_invalid_token:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_token
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
                - token_disabled
                - organization_required
                - insufficient_role
                - mfa_required
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_not_found:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_rate_limit_exceeded:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - rate_limit_exceeded
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_internal_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - internal_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_service_unavailable:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - service_unavailable
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      description: >-
        Personal API key sent as a bearer token, together with
        X-Organization-Id. The key must have at least the access level the
        endpoint requires (read, write or admin).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.