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

# Request a custom workflow run

> Request a workflow run with explicit period bounds, or omit both for a full-agreement run for the month so far.



## OpenAPI

````yaml api-reference/platform-api.json post /v2/workflows/runs/custom
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.37
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/workflows/runs/custom:
    post:
      tags:
        - Workflows
      summary: >-
        Create a custom run with explicit period boundaries (CARF: any whole-day
        Europe/London range up to 366 days; treasury-statement /
        transfer-attribution: utc day/month/year). Full agreement may omit the
        period to compute the month so far
      operationId: generateCustom
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomWorkflowRunDto'
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueuedWorkflowRunDto'
components:
  schemas:
    CreateCustomWorkflowRunDto:
      type: object
      properties:
        workflow_id:
          type: string
          format: uuid
        period_start:
          type: string
          format: date-time
          example: '2024-01-01T00:00:00Z'
          description: >-
            Inclusive start with an explicit timezone. Required except for a
            full-agreement run-now, which omits both bounds and computes the
            month so far. Template-specific: CARF requires January 1 UTC
            midnight (year ≥ 1970); treasury-statement requires any UTC midnight
            day boundary within a ≤366-day half-open interval;
            transfer-attribution requires one within a ≤31-day half-open
            interval (a day, a week or a month); full-agreement requires 00:00
            UTC on the first of a month, or the current month to mean
            month-so-far.
        period_end:
          type: string
          format: date-time
          example: '2025-01-01T00:00:00Z'
          description: >-
            Exclusive end with an explicit timezone. Required except for a
            full-agreement run-now. Template-specific: CARF requires the
            following January 1 UTC midnight; treasury-statement and
            transfer-attribution require a later UTC midnight within the
            supported span; full-agreement requires 00:00 UTC on the first of
            the next month.
      required:
        - workflow_id
    QueuedWorkflowRunDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        workflow_id:
          type: string
          format: uuid
        occurrence_at:
          type: string
          nullable: true
          format: date-time
        rerun_of:
          type: string
          nullable: true
          format: uuid
        requested_cutoff:
          format: date-time
          type: string
          description: >-
            Inclusive observation bound; period.end is the exclusive end of the
            stored half-open period.
        execution_status:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - failed
            - cancelled
            - skipped
        tx_sync_status:
          type: string
          enum:
            - not_applicable
            - waiting
            - completed
            - expired
        delivery_status:
          type: string
          enum:
            - not_required
            - pending
            - sending
            - sent
            - failed
            - cancelled
            - held
        review_status:
          type: string
          enum:
            - not_required
            - needs_labels
            - awaiting_review
            - sent
          description: >-
            CARF review: `needs_labels` and `awaiting_review` are held (delivery
            `held`); `sent` once released.
        carf_missing_count:
          type: number
          nullable: true
          description: 'CARF: reported transfers with no type. Null outside CARF review.'
        created_at:
          type: string
          format: date-time
        cases:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowRunCaseDto'
        period:
          $ref: '#/components/schemas/WorkflowRunPeriodDto'
        warnings:
          type: array
          items:
            type: string
        reason:
          type: string
          nullable: true
        queued_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
          nullable: true
          example: null
      required:
        - id
        - workflow_id
        - occurrence_at
        - rerun_of
        - requested_cutoff
        - execution_status
        - tx_sync_status
        - delivery_status
        - review_status
        - carf_missing_count
        - created_at
        - cases
        - period
        - warnings
        - reason
        - queued_at
        - started_at
    WorkflowRunCaseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        kind:
          type: string
          enum:
            - execution
            - delivery
            - tie_out_break
            - corridor_discrepancy
            - agreement_break
          description: >-
            `execution` and `delivery` are the run-level cases; `tie_out_break`
            is a per-line Break case, `corridor_discrepancy` a per-Corridor
            discrepancy case, and `agreement_break` a per wallet, asset and
            month case the run created or matched.
      required:
        - id
        - kind
    WorkflowRunPeriodDto:
      type: object
      properties:
        start:
          type: string
        end:
          type: string
        label:
          type: string
      required:
        - start
        - end
        - label
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

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