> ## Documentation Index > Fetch the complete documentation index at: https://docs.filexpress.app/llms.txt > Use this file to discover all available pages before exploring further. # Reverse payment > Reverses an applied payment and recalculates the purchase's payment status. **Required permission:** `payables.payments` ## OpenAPI ````yaml /api-reference/openapi.en.json post /payables/payments/{paymentId}/reverse openapi: 3.0.3 info: title: FileXpress External API version: 1.0.0 description: >- API for integrating third-party systems with FileXpress: billing, HR, accounting, inventory, projects, accounts receivable and payable, treasury, pricing and promotions, and cash. Current base URL: /api/external/v1. The legacy unversioned path (/api/external) will be removed on January 1, 2027; migrate to /api/external/v1 (same endpoints, only the base URL changes). The v2 API (/api/external/v2) exposes currencies and exchange rates, sales and purchases in foreign currency, taxes by id, payrolls with branch, and errors with a stable `code`; its operations carry the /v2 prefix in the path. We suggest migrating to the available v2 routes before March 30, 2027. servers: - url: https://api.filexpress.app/api/external/v1 description: Production security: - ApiKey: [] tags: - name: General - name: Billing · Sales - name: Billing · Purchases - name: Billing · Customers - name: Billing · Suppliers - name: Billing · Products - name: Catalogs - name: HR · Employees - name: HR · Attendance - name: HR · Labor rules - name: HR · Schedules - name: HR · Holidays - name: HR · Attendance results - name: HR · Leave requests - name: HR · Payrolls - name: Accounting - name: Inventory - name: Projects - name: Accounts receivable - name: Accounts payable - name: Treasury - name: Pricing and promotions - name: Cash - name: Points of sale - name: API v2 · General - name: API v2 · Currencies and rates - name: API v2 · Countries - name: API v2 · Sales - name: API v2 · Purchases - name: API v2 · Payrolls paths: /payables/payments/{paymentId}/reverse: post: tags: - Accounts payable summary: Reverse payment description: >- Reverses an applied payment and recalculates the purchase's payment status. **Required permission:** `payables.payments` parameters: - name: paymentId in: path required: true description: Payment ID schema: type: string format: uuid example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11 - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/ReverseRequest' example: reason: Pago duplicado responses: '200': description: Success content: application/json: schema: type: object required: - status - data properties: status: type: boolean example: true data: $ref: '#/components/schemas/PayableReversal' example: status: true data: reversed_payment: payment_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01 original_amount: 300 reversal_reason: Pago duplicado reversed_at: '2026-10-06T16:00:00-06:00' expense_info: expense_id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11 generation_code: A1B2C3D4-0000-4C5D-9E6F-0A1B2C3D4E5F total_amount: 452 total_paid: 0 pending_amount: 452 payment_status: pending accounting: action: reversed journal_entry_id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01 entry_code: DIA-000145 status: PROCESADA headers: Idempotent-Replayed: $ref: '#/components/headers/IdempotentReplayed' '401': $ref: '#/components/responses/E401' '403': $ref: '#/components/responses/E403' '404': description: Not found or belongs to another business content: application/json: schema: $ref: '#/components/schemas/Error' example: status: false message: Payment not found '409': description: Payment already reversed or idempotency conflict content: application/json: schema: $ref: '#/components/schemas/Error' examples: reversed: summary: Pago ya revertido value: status: false message: El pago ya fue revertido. idem_body: summary: Idempotency-Key reutilizada con otro cuerpo value: status: false message: >- This Idempotency-Key was already used with a different request. idem_busy: summary: Petición con la misma llave en proceso value: status: false message: >- A request with this Idempotency-Key is already being processed. '422': description: Validation error content: application/json: schema: $ref: '#/components/schemas/Error' example: status: false message: Validation errors errors: reason: - The reason must not be greater than 500 characters. '429': $ref: '#/components/responses/E429' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: >- Optional. Unique key per operation (max. 100 characters, valid for 24 h per integration). A retry with the same key and the same body returns the original response (header `Idempotent-Replayed: true`) without repeating the operation; with a different body, or while the first is still in progress, it returns 409. schema: type: string maxLength: 100 example: pago-2026-10-06-000123 schemas: ReverseRequest: type: object properties: reason: type: string maxLength: 500 description: Reason (default "Payment reversed"). PayableReversal: type: object properties: reversed_payment: type: object properties: payment_id: type: string format: uuid original_amount: type: number reversal_reason: type: string reversed_at: type: string format: date-time required: - payment_id expense_info: type: object properties: expense_id: type: string format: uuid generation_code: type: string total_amount: type: number total_paid: type: number pending_amount: type: number payment_status: type: string description: Payment status. enum: - pending - partial - payed required: - expense_id - pending_amount - payment_status accounting: $ref: '#/components/schemas/ReversalAccounting' required: - reversed_payment - expense_info Error: type: object properties: status: type: boolean example: false message: type: string errors: type: object additionalProperties: type: array items: type: string description: Errors per field (validation only). required: - status - message ReversalAccounting: type: object properties: action: type: string description: Effect on the payment's journal entry. enum: - none - deleted - reversed journal_entry_id: type: string format: uuid nullable: true entry_code: type: string nullable: true status: type: string nullable: true required: - action headers: IdempotentReplayed: description: >- `true` when the response is the replay of a previous request with the same Idempotency-Key. schema: type: string enum: - 'true' responses: E401: description: Missing or invalid API Key content: application/json: example: status: false message: Invalid API Key. E403: description: Integration without the required permission or deactivated content: application/json: example: status: false message: This integration does not have the 'hr.employees' permission. required_scope: hr.employees E429: description: Rate limit exceeded content: application/json: example: status: false message: Rate limit exceeded. Please try again later. rate_limit: 100 securitySchemes: ApiKey: type: apiKey in: header name: X-API-Key description: Integration API Key (Integrations → New Integration). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.