evenbooks
Sign inStart for free

Refunds

Money returned to customers.

Paths are relative to https://evenbooks.org/api/v1. How keys, errors, paging and versions work is in the guide; the whole reference is also an OpenAPI 3.1 document.

Administrator key marks endpoints that need a key with the admin role, Write access those a read-only key can’t call, and Idempotent those that accept an idempotency key.

List refunds

get/refunds

Money returned to customers, newest first; at most 200. Filter by the payment or credit note refunded, or by customer.

Parameters

  • paymentIdstring (uuid)query
  • creditNoteIdstring (uuid)query
  • contactIdstring (uuid)query

Response 200

array of RefundDto

Errors 400 · 401 · 403 · 404 · 409 · 429

Refund a customer

post/refunds
Write accessIdempotent

Pays money back from fromAccountId (a bank, card, Undeposited Funds or payment processor account) out of the unapplied part of a payment or the balance left on an issued credit note; more than that is refused (400 over_allocation). Posts to the books on date, which cannot be before the payment or credit note; refused in a locked period (409 period_locked).

Request body

CreateRefundInput

  • sourceTypestringrequired

    One of: payment credit_note

  • sourceIdstring · Uuidrequired
  • datestring · PlainDateStringrequired
  • amountstring · PositiveDecimalStringrequired
  • fromAccountIdstring · Uuidrequired
  • methodstring

    One of: cash check card ach wire other

    default "other"

  • referencestring or null

    up to 100 characters

  • memostring or null

    up to 1000 characters

  • idempotencyKeystring · IdempotencyKey

Response 200

RefundDto (fields under Schemas)

Errors 400 · 401 · 403 · 404 · 409 · 429

Void a refund

post/refunds/{id}/void
Write accessIdempotent

Cancels a refund by posting a reversing entry on the refund’s date; the money is available again on the payment or credit note. Refunds made through Stripe cannot be voided (409 invalid_state). Refused in a locked period (409 period_locked).

Parameters

  • idstring (uuid)path · required

Request body

VoidRefundInput

  • reasonstringrequired

    1–500 characters

  • idempotencyKeystring · IdempotencyKey

Response 200

RefundDto (fields under Schemas)

Errors 400 · 401 · 403 · 404 · 409 · 429

Schemas

The types these endpoints take or return, by name. Type names above link here.

DecimalString

decimal string

string

up to 32 characters · pattern ^-?\d+(\.\d+)?$

IdempotencyKey

string

8–128 characters

NonNegativeDecimalString

string

up to 32 characters · pattern ^\d+(\.\d+)?$

PlainDateString

string

pattern ^\d{4}-\d{2}-\d{2}$

PositiveDecimalString

string

RefundDto

  • idstring
  • contactIdstring or null
  • sourceTypestring

    One of: payment credit_note

  • paymentIdstring or null
  • creditNoteIdstring or null
  • datestring · PlainDateString
  • amountstring · DecimalString
  • fromAccountIdstring
  • fromAccountNamestringoptional
  • methodstring
  • referencestring or null
  • memostring or null
  • statusstring

    One of: posted void

  • journalEntryIdstring
  • voidJournalEntryIdstring or null
  • createdAtstring

Uuid

string (uuid)