---
title: "Create VendorRefund record"
method: POST
path: "/public/v1/vendor-refunds/"
tags: ["Vendor Refunds"]
---

# Create VendorRefund record

`POST /public/v1/vendor-refunds/`

Create a new VendorRefund record with the provided data. Validates all required fields and business rules.

## Request body

- PublicVendorRefundSchemaCreateIn
  - `custom_fields` object[], nullable
  - `date` string, date, required
  - `transaction_date` string, date, nullable
  - `company_id` integer, required
  - `vendor_id` integer, required
  - `check_number` string
  - `account_number` integer, required
  - `currency_iso_4217_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required
  - `exchange_rate` union, required
    - number
    - string
  - `memo` string
  - `items` PublicVendorRefundItemIn[]
    - `id` integer, nullable
    - `vendor_credit_number` integer, nullable
    - `vendor_prepayment_number` integer, nullable
    - `amount` union, required
      - number
      - string
    - `position` integer, required
  - `attachments` AttachmentSchemaOut[]
    - `id` integer, required
    - `file_name` string, required
    - `file_size` integer, required
    - `download_url` string, nullable
    - `upload_url` string, nullable
    - `category` string
  - `bank_or_credit_card_amount` union — Bank or credit card amount
    - number
    - string
  - `payment_method_id` integer, nullable
  - `record_status` 'draft' | 'posted' | 'archived'

## Response `200`

OK

- PublicVendorRefundSchemaOut
  - `custom_fields` CustomFieldValuePairOutputSchema[]
    - `field` CustomFieldSchemaOut, required
      - `id` integer, required
      - `company_id` integer, nullable
      - `company_ids` integer[], nullable
      - `name` string, required
      - `description` string, nullable, required
      - `helper_text` string, nullable, required
      - `field_type` 'text' | 'number' | 'currency' | 'date' | 'boolean' | 'single_select' | 'multi_select' | 'link' | 'paragraph', required
      - `applies_to` AppliesToItemSchema[], required
        - `type` 'invoice' | 'bill' | 'direct_expense' | 'journal_entry' | 'vendor_prepayment' | 'vendor_credit' | 'vendor_payment' | 'vendor_refund' | 'customer_payment' | 'customer_prepayment' | 'customer_refund' | 'customer_deposit' | 'currency_revaluation' | 'contract' | 'fixed_asset' | 'customer' | 'vendor' | 'company' | 'sales_order' | 'cash_sale' | 'customer_credit', required
        - `is_active` boolean
        - `is_required` boolean
      - `default_value` union
        - string
        - string[]
      - `options` string[], nullable, required
      - `is_active` boolean, nullable, required
    - `value` CustomFieldValueSchemaOut
      - `id` integer, required
      - `custom_field_id` integer, required
      - `custom_field_name` string, required
      - `custom_field_type` string, required
      - `custom_field_value_id` integer, required
      - `value` unknown, required
      - `created_at` string, required
      - `updated_at` string, required
  - `attachments` PublicAttachmentSchemaOut[]
    - `id` integer, required
    - `file_name` string, required
    - `file_size` integer, required
    - `download_url` string, nullable
  - `classifications` PublicRecordClassificationsSchemaOut[]
    - `id` integer, required
    - `name` string, required
    - `line_id` integer, required
    - `line_name` string, required
    - `parent_classification_id` integer, nullable
    - `parent_classification_line_id` integer, nullable
  - `transaction_ids` integer[], required
  - `created_by` AuditActorSchemaOut — Schema for audit actor information.
    - `actor_type` string, nullable
    - `email` string, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `timestamp` string, date-time, nullable
  - `updated_by` AuditActorSchemaOut — Schema for audit actor information.
    - `actor_type` string, nullable
    - `email` string, nullable
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `timestamp` string, date-time, nullable
  - `internal_id` integer, required
  - `number` integer, required
  - `account_number` integer, nullable, required
  - `items` PublicVendorRefundItemOut[], required
    - `vendor_credit_number` integer, nullable
    - `vendor_prepayment_number` integer, nullable
    - `amount` string, required
    - `position` integer, required
    - `bank_or_credit_card_amount` string, required
  - `company_id` integer, required
  - `company_name` string, required
  - `company_currency` string, required
  - `vendor_id` integer, required
  - `vendor_name` string, required
  - `memo` string, required
  - `check_number` string, required
  - `date` string, date, required — Posting date (GL date) - the date when the transaction is recorded in the general ledger
  - `transaction_date` string, date, required — Transaction date (inception date) - the date when the transaction actually occurred
  - `currency_iso_4217_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required
  - `exchange_rate` string, required
  - `bank_or_credit_card_amount` string, required
  - `amount` string, required — Total transaction amount
  - `record_status` 'draft' | 'posted' | 'archived', required
  - `payment_method_id` integer, nullable
  - `paper_check_status` 'printed' | 'not_printed' | 'archived', required
  - `created_at` string, date-time, required — Date and time the record was created
  - `updated_at` string, date-time, required — Date and time the record was last updated

## Other responses

- `404` — Not Found
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/dualentry/apis/dualentry-public-api-2.md) · [All operations](https://skmtc.net/dualentry/apis/dualentry-public-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dualentry/dualentry-public-api-2/versions/77cd3c6ec719/schema)