> For the complete documentation index, see [llms.txt](https://voyzu.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://voyzu.gitbook.io/docs/help-core/financial-documents/ap_refund.md).

# AP\_REFUND

{% hint style="info" %}
`POST /api/finance/process-document/AP_REFUND`

`POST /api/finance/process-document/AP_REFUND?preview`

**?preview parameter**

If `preview` is passed then no ledger posting, subledger entries, or persisted records are created. The response shape is identical to a live request.
{% endhint %}

The AP\_REFUND endpoint records money received back from a supplier from the supplier's available unapplied AP balance.

### Request Object

This request object has the following notable properties:

* A single AP Counterparty per document is supported.
* Refunds are sourced from the supplier's available unapplied AP balance.
* A single Bank / Cash account is supported.
* If `bank_cash_account_code` is omitted, the configured document default Bank / Cash account is used.
* If `bank_cash_account_code` is supplied, it overrides the document default and must identify a valid active Bank / Cash account for the company.
* Refund amounts cannot exceed available unapplied balances.
* No tax, purchase, expense, or new credit movement is created.

**Annotated Example:**

```jsonc
{
  // Required. Must be "AP_REFUND"
  "document_type": "AP_REFUND",

  // Required. Company code
  "company_code": "NZ_COMPANY_001",

  // Required. Existing AP Counterparty code
  "ap_counterparty_code": "SUPP_001",

  // Optional. Caller document identifier; generated if omitted
  "document_id": "REF-1001",

  // Optional. Brief caller memo
  "memo": "Supplier refund received",

  // Required. Date of refund
  "refund_date": "2026-05-12",

  // Optional. Defaults to refund_date
  "posting_date": "2026-05-12",

  // Required. Total amount refunded
  "refund_amount": "500.00",

  // Optional. Overrides the document default Bank / Cash account.
  // Must identify a valid active Bank / Cash account for the company.
  "bank_cash_account_code": "BANK_OPERATING",

  // Optional. Bank / Cash transaction details
  "bank_cash_details": {
    "tx_id": "TX-123456789",
    "tx_code": "CR",
    "tx_ref": "BANK-REF-001",
    "tx_details": "Dummy supplier refund transaction details",
    "payment_ref": "REF-1001"
  }
}
```

### Response Object

The response contains:

* `detailed_document` The validated refund.
* `ap_subledger_details` AP Subledger details.
* `posting_details` Company Ledger journal details.

```json
{
  "detailed_document": { /* ... */ },
  "ap_subledger_details": { /* ... */ },
  "posting_details": { /* ... */ }
}
```

For `?preview`, status fields are `EPHEMERAL` instead of `POSTED`.

## Financial / Ledger Treatment Principles

### Journal treatment

The engine debits the selected Bank / Cash account and credits unapplied supplier balance.

```txt
Dr BANK_OPERATING                500.00
  Cr AP_UNAPPLIED_SUPPLIER_PAYMENTS 500.00
```

### Bank / Cash account selection

| Slot name                | Scope  | Description                                                                                                                       |
| ------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------- |
| `bank_cash_account_code` | Header | Optional Bank / Cash account slot used to select the refund bank/cash posting target. If omitted, the configured default is used. |

### Tax treatment

AP\_REFUND has no direct tax treatment and creates no Tax Ledger entries.

### AP Subledger treatment

`AP_REFUND` reduces the supplier's available unapplied AP balance.

### Inventory treatment

AP\_REFUND has no inventory implications and creates no Inventory Ledger entries.

### Date treatment

`refund_date` must be supplied. `posting_date` may be supplied. If not supplied, `posting_date` defaults to `refund_date`.

### Bank Details

AP\_REFUND supports Bank / Cash details.

If `bank_cash_account_code` is omitted, the configured AP\_REFUND Bank / Cash account default is used. If supplied, `bank_cash_account_code` overrides the default and must identify a valid active Bank / Cash account for the company. Voyzu resolves the selected Bank / Cash account to its linked GL account.

If `bank_cash_details` is supplied, it records transaction/reference details for the selected Bank / Cash account.

### Dimensions treatment

`AP_REFUND` does not support dimensions. If dimensions are supplied, the transaction is rejected.

## Use cases

### Refund available unapplied supplier balance

```txt
Dr BANK_OPERATING                500.00
  Cr AP_UNAPPLIED_SUPPLIER_PAYMENTS 500.00

AP Subledger:
  Credit: 500.00 against unapplied supplier balance
  Effect: records money received back from supplier
```

## Considerations

* Refunds are made from unapplied supplier balance, not bill lines.
* Refund amounts cannot exceed available unapplied balance.
* No purchase, expense, or tax is created or reversed by a refund.