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

# List this journal's sends

> Every attempt to send this journal to an accounting system, oldest first, with what came back.



## OpenAPI

````yaml /api-reference/specs/journal.json get /journals/{journalId}/postings
openapi: 3.0.1
info:
  title: Journal Service
  description: Journal API for FlowPayroll
  version: v1
servers:
  - url: https://api.sandbox.flowpayroll.ai/v1/journal
security:
  - X-Auth-Token: []
    X-Org-Id: []
tags:
  - name: Journals
    description: >-
      The accounting journals produced from each finalised pay run: list them,
      retrieve the latest or a specific version for a pay run, review history,
      rebuild or reissue, and download exports.
  - name: Journal templates
    description: >-
      Define how a pay run becomes an accounting journal. Create, update, clone,
      preview (as data, CSV, or PDF), import, export, and view the history of
      templates.
  - name: Pay element mappings
    description: Map each pay element to the nominal code it posts to within a template.
  - name: Control account mappings
    description: >-
      Map control accounts (net pay, PAYE, NI, pension, and other liabilities)
      to nominal codes within a template.
  - name: Split dimensions
    description: >-
      Analysis dimensions such as department or cost centre that split journal
      lines into tracking categories or account-code segments.
  - name: Split value mappings
    description: >-
      Map each value of a split dimension to its tracking code or account
      segment.
  - name: Org journal settings
    description: Read and update the organisation-level journal defaults.
  - name: Journal export metadata
    description: >-
      Reference data for building templates: export presets, date-format
      presets, narration and reference tokens, and account-code separators.
paths:
  /journals/{journalId}/postings:
    get:
      tags:
        - Journals
      summary: List this journal's sends
      description: >-
        Every attempt to send this journal to an accounting system, oldest
        first, with what came back.
      operationId: ListJournalPostings
      parameters:
        - name: journalId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalPostingListResponseResponseBody'
components:
  schemas:
    JournalPostingListResponseResponseBody:
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageWithTokenResponse'
        content:
          allOf:
            - $ref: '#/components/schemas/JournalPostingListResponseContentResponse'
          nullable: true
        validationIssues:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssue'
          nullable: true
      additionalProperties: false
    MessageWithTokenResponse:
      type: object
      properties:
        text:
          type: string
        token:
          type: string
        tokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    JournalPostingListResponseContentResponse:
      type: object
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/JournalPostingListResponse'
          nullable: true
        metadata:
          $ref: '#/components/schemas/ContentMetadataResponse'
      additionalProperties: false
    ValidationIssue:
      type: object
      properties:
        field:
          type: string
        reason:
          type: string
        reasonToken:
          type: string
        reasonTokenArguments:
          type: array
          items:
            $ref: '#/components/schemas/ValidationIssueArgument'
          nullable: true
      additionalProperties: false
    ValidationIssueArgument:
      type: object
      properties:
        name:
          type: string
        value:
          nullable: true
      additionalProperties: false
    JournalPostingListResponse:
      type: object
      properties:
        postings:
          type: array
          items:
            $ref: '#/components/schemas/JournalPostingResponse'
      additionalProperties: false
    ContentMetadataResponse:
      type: object
      properties:
        dateFormat:
          type: string
        dateTimeFormat:
          type: string
        paginationToken:
          type: string
          nullable: true
      additionalProperties: false
    JournalPostingResponse:
      type: object
      properties:
        attempt:
          type: integer
          description: Which send this was, from 1.
          format: int32
        status:
          enum:
            - Sending
            - Sent
            - Failed
            - NeedsAttention
          type: string
          description: "Where this attempt has got to. The values are on the enum; Sent,\r\nFailed and NeedsAttention are terminal, so a client polling this\r\nresource should stop on any of them. Poll no faster than every 5\r\nseconds — a send typically settles within a few seconds of leaving,\r\nand the same states are pushed live over the websocket."
        providerName:
          type: string
        providerReference:
          type: string
          description: "The accounting system's own reference for the entry it created, once\r\nit has one. Present on a Sent attempt; use it to reconcile against\r\nthe entry in the accounting system."
          nullable: true
        errorToken:
          type: string
          description: "Stable, provider-neutral reason it did not land, for a client to turn\r\ninto its own sentence. Never a raw message from the accounting\r\nsystem, and safe to branch on: the vocabulary is shared across every\r\nprovider, so handling it does not tie a client to one of them."
          nullable: true
        createdBy:
          type: string
          description: Who pressed send.
        createdDate:
          type: string
          description: When the send was started (UTC).
        updatedDate:
          type: string
          description: "When the accounting system answered (UTC), on a settled attempt —\r\nthe provider's own moment, not when this service recorded it, so the\r\nfigure is safe to reconcile against the provider's records and does\r\nnot move with our queue timings. Equals `createdDate` while the\r\nattempt is still Sending."
      additionalProperties: false
      description: "One attempt at sending a journal to the accounting system it is\r\nlinked to."
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      description: FlowPayroll JWT (raw token, no Bearer prefix)
      name: X-Auth-Token
      in: header
    X-Org-Id:
      type: apiKey
      description: >-
        Organisation to scope the request to. Required when the principal can
        access more than one organisation; optional for single-organisation
        principals (the authorizer resolves it automatically).
      name: X-Org-Id
      in: header

````

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