> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Update an Operation > Use this endpoint to update the details of an Operation. ## OpenAPI ````yaml /en/openapi/v3-current/ledger.yaml patch /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id} openapi: 3.1.0 info: title: Midaz Ledger API description: >- Complete API reference for Midaz Ledger services including organization management, ledger operations, assets, segments, portfolios, accounts, account types, transactions, operations, balances, operation routes, transaction routes, and metadata indexes. version: 3.7.0 servers: - url: https://ledger.sandbox.lerian.net security: [] tags: - name: Organizations API - name: Ledgers API - name: Assets API - name: Segments API - name: Portfolios API - name: Account Types API - name: Accounts API - name: Balances API - name: Transactions API - name: Operations API - name: Operation Routes API - name: Transaction Routes API - name: Metadata Indexes API paths: /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}: patch: tags: - Operations API summary: Update an Operation description: Use this endpoint to update the details of an Operation. parameters: - $ref: '#/components/parameters/OrganizationId' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/LedgerId' - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/OperationId' - $ref: '#/components/parameters/TransactionId' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: type: object properties: description: type: string maxLength: 256 description: The description for the operation. metadata: $ref: '#/components/schemas/Metadata' example: description: Credit pix - Updated metadata: notes: Payment reference updated originalAmount: '1000' channel: pix updatedBy: system reason: customer_request responses: '200': description: >- Indicates that the request was successful and the response contains the expected data. content: application/json: schema: $ref: '#/components/schemas/GetOperationResponse' headers: {} '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0022: $ref: '#/components/examples/Error0022' Error0009: $ref: '#/components/examples/Error0009' Error0047: $ref: '#/components/examples/Error0047' '401': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0041: $ref: '#/components/examples/Error0041' Error0042: $ref: '#/components/examples/Error0042' '403': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0043: $ref: '#/components/examples/Error0043' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0068: $ref: '#/components/examples/Error0068' '500': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0046: $ref: '#/components/examples/Error0046' security: - bearer: [] components: parameters: OrganizationId: name: organization_id in: path description: The unique identifier of the Organization associated with the Ledger. required: true example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string Authorization: name: Authorization in: header description: >- The authorization token. **This header is required if your environment has Access Manager enabled**. required: false schema: type: string LedgerId: name: ledger_id in: path description: The unique identifier of the associated Ledger. required: true example: 019c96a0-0ac0-7de9-9f53-9cf842a2ee5a schema: type: string ContentType: name: Content-Type in: header description: >- The type of media of the resource. Recommended value is `application/json`. required: false example: application/json schema: type: string OperationId: name: operation_id in: path description: The unique identifier of the operation that you want to retrieve. required: true example: 019c96a0-10d2-7193-8841-0d7347efd09a schema: type: string TransactionId: name: transaction_id in: path description: The unique identifier of the transaction you want to retrieve. required: true example: 019c96a0-10ce-75fc-a273-dc799079a99c schema: type: string XRequestId: name: X-Request-Id in: header description: A unique identifier used to trace and track each request. required: false example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string format: uuid schemas: Metadata: type: object additionalProperties: type: string description: >- An object containing key-value pairs to add as metadata, where the field `name` is the key and the field `value` is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'. GetOperationResponse: type: object properties: id: type: string description: The unique identifier of the Operation. format: uuid transactionId: type: string format: uuid description: The unique identifier of the Transaction. organizationId: type: string format: uuid description: The unique identifier of the Organization. ledgerId: type: string description: The unique identifier of the Ledger. format: uuid accountId: type: string description: The unique identifier of the Account. format: uuid accountAlias: type: string description: The alias for the account used in the operation. balanceId: type: string description: The unique identifier of the Balance. balanceKey: type: string description: The unique key that identifies the Balance. description: type: string description: Description of the transaction. type: type: string description: >- The type of the operation. `OVERDRAFT` identifies system-generated companion operations on the internal `"overdraft"` balance — `direction` then carries the lifecycle semantics (`debit` for a draw, `credit` for a repayment). enum: - CREDIT - DEBIT - ON_HOLD - RELEASE - OVERDRAFT assetCode: type: string description: The name of the asset used in the operation. chartOfAccounts: type: string description: The name of the Chart-of-Accounts that the operation belongs to. route: type: string deprecated: true description: >- **Deprecated.** Use `routeId` instead. Will be removed in the next major version. The unique ID of the operation route for this transaction leg. routeId: type: string format: uuid description: >- The unique identifier of the operation route associated with this operation. Companion overdraft operations inherit this value from the primary operation that triggered them. routeCode: type: string maxLength: 100 description: >- A human-readable code for the operation route, useful for audit trail and traceability. routeDescription: type: string description: >- The description of the operation route associated with this operation. direction: type: string enum: - debit - credit description: The direction of the operation in double-entry accounting. amount: type: object description: >- An object containing information about the amount used in the operation. properties: value: type: string description: The amount that will be sent. balance: type: object description: >- An object containing information about the balance before the operation. properties: available: type: string description: Previous available balance. onHold: type: string description: Amount on hold/reserved. version: type: integer description: Balance version, which is updated with each transaction. overdraftUsed: type: string description: >- The overdraft consumed by this balance before the operation, as a decimal string. `"0"` for operations that do not touch overdraft. balanceAfter: type: object description: >- An object containing information about the balance after the operation. properties: available: type: string description: Current available balance. onHold: type: string description: Amount on hold/reserved. version: type: integer description: Balance version, which is updated with each transaction. overdraftUsed: type: string description: >- The overdraft consumed by this balance after the operation, as a decimal string. `"0"` for operations that do not touch overdraft. status: type: object description: The transaction status (pending, completed, reversed). properties: code: type: string description: Transaction status code. description: type: string description: Transaction status description. nullable: true balanceAffected: type: boolean description: If true, indicates that the operation affected the account balance. createdAt: type: string format: date-time description: Timestamp of creation (UTC). updatedAt: type: string format: date-time description: Timestamp of last update (UTC). deletedAt: type: string format: date-time description: Timestamp of soft deletion, if applicable (UTC). nullable: true metadata: $ref: '#/components/schemas/Metadata' ErrorFormat: type: object description: The response message error. required: - code - title - message properties: code: type: string description: A unique, stable identifier for the error. title: type: string description: A brief summary of the issue. message: type: string description: Detailed guidance for resolving the error. fields: type: object additionalProperties: true description: Additional information about the fields that caused the error. examples: Error0022: value: code: '0022' title: Immutable Field Error message: >- The {{field}} field cannot be modified. Please remove this field from your request and try again. summary: Immutable Field Error Error0009: summary: Missing Fields in Request value: code: '0009' title: Missing Fields in Request message: >- Your request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request. fields: metadataKey: metadataKey is a required field Error0047: summary: Bad Request value: code: '0047' title: Bad Request message: >- The server could not understand the request due to malformed syntax. Please check the listed fields and try again. Error0041: summary: Token Missing value: code: '0041' title: Token Missing message: >- A valid token must be provided in the request header. Please include a token and try again. Error0042: summary: Invalid Token value: code: '0042' title: Invalid Token message: >- The provided token is expired, invalid or malformed. Please provide a valid token and try again. Error0043: summary: Insufficient Privileges value: code: '0043' title: Insufficient Privileges message: >- You do not have the necessary permissions to perform this action. Please contact your administrator if you believe this is an error. Error0068: value: code: '0068' title: Operation ID Not Found message: >- The provided operation ID does not exist in our records. Please verify the operation ID and try again. summary: Operation ID Not Found Error0046: summary: Internal Server Error value: code: '0046' title: Internal Server Error message: >- The server encountered an unexpected error. Please try again later or contact support. securitySchemes: bearer: type: http scheme: bearer ````