Files
sxchnge/backend/contracts/sendico/api/ledger_accounts/operation.yaml
T

37 lines
1.5 KiB
YAML

get:
tags: [Ledger Accounts]
summary: Get ledger account operation detail
description: |
Returns the account-history projection for `entry_ref` within the requested ledger account.
This is not a general journal-entry read API.
The endpoint returns `404` when the entry is not part of the requested account's visible history.
operationId: ledgerAccountOperationsGet
security:
- bearerAuth: []
parameters:
- $ref: ../parameters/organizations_ref.yaml#/components/parameters/OrganizationsRef
- $ref: ../parameters/ledger_account_ref.yaml#/components/parameters/LedgerAccountRef
- $ref: ../parameters/entry_ref.yaml#/components/parameters/EntryRef
responses:
'200':
description: Ledger account operation detail
content:
application/json:
schema:
allOf:
- $ref: ../response/response.yaml#/components/schemas/BaseResponse
- type: object
properties:
data:
$ref: ./response/operation.yaml#/components/schemas/LedgerAccountOperationData
'400':
$ref: ../response/operation.yaml#/components/responses/BadRequest
'401':
$ref: ../response/operation.yaml#/components/responses/Unauthorized
'403':
$ref: ../response/operation.yaml#/components/responses/Forbidden
'404':
$ref: ../response/operation.yaml#/components/responses/NotFound
'500':
$ref: ../response/operation.yaml#/components/responses/InternalServerError