A Refund represents money returned to a customer, supporting both itemized refunds (with line items) and allocation-based refunds (applied to invoices, credit notes, or overpayments).
Apideck Refunds API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (apiKey).
By default, every request must be authenticated.
apiKey — To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Refunds 5
A Refund represents money returned to a customer, supporting both itemized refunds (with line items) and allocation-based refunds (applied to invoices, credit notes, or overpaymen…
The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are Refund (38 properties), InvoiceLineItem (35 properties), Address (25 properties), GetRefundsResponse (9 properties). Each schema is shown below with its type and property counts.
UnauthorizedResponse
object
6 properties
DownstreamId
stringnull
The third-party API ID of original entity
LocationId
stringnull
The ID of the location
InvoiceLineItem
object
35 properties
Address
object
25 properties
NotFoundResponse
object
6 properties
PaymentMethod
stringnull
Payment method used for the transaction, such as cash, credit card, bank transfer, or check
LineNumber
integernull
Line number of the resource
TotalTax
numbernull
Total tax amount applied to this transaction.
UnitPrice
numbernull
PaymentMethodReference
stringnull
Optional reference message returned by payment method on processing
RefundType
string
Type of refund. refundreceipt for itemized refunds with product/service lines and payment (QBO RefundReceipt, NetSuite CashRefund). cashrefund for cash-out ref…
RefundsSort
object
2 properties
DeleteRefundResponse
object
7 properties6 required
LinkedCustomer
objectnull
The customer this entity is linked to.
6 properties
CurrencyRate
numbernull
Currency Exchange Rate at the time entity was recorded/generated.
UnitOfMeasure
stringnull
Description of the unit type the item is sold as, ie: kg, hour.
TaxInclusive
booleannull
Amounts are including tax
WritableId
stringnull
A unique identifier for an object.
Refund
object
38 properties2 required
UnexpectedErrorResponse
object
6 properties
UpdatedAt
stringnull
The date and time when the object was last updated.
LinkedLedgerAccount
objectnull
6 properties
SortDirection
string
The direction in which to sort the results
LinkedLocation
objectnull
4 properties
Id
string
A unique identifier for an object.
RefundsFilter
object
2 properties
Links
object
Links to navigate to previous or next pages through the API
3 properties
TotalAmount
numbernull
The total amount of the transaction or record
Meta
object
Response metadata
2 properties
CreatedAt
stringnull
The date and time when the object was created.
PassThroughBody
array
The passthrough property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.
DisplayId
stringnull
Id to be displayed.
PaymentRequiredResponse
object
6 properties
SubsidiaryId
stringnull
The ID of the subsidiary
SubTotal
numbernull
Subtotal amount, normally before tax.
GetRefundsResponse
object
9 properties6 required
PassThroughQuery
object
1 property
UnprocessableResponse
object
6 properties
Currency
stringnull
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO4217).
LinkedWorktag
objectnull
2 properties
RowVersion
stringnull
A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
CustomMappings
objectnull
When custom mappings are configured on the resource, the result is included here.
LinkedDepartment
objectnull
4 properties
Name
stringnull
The name of the resource.
LinkedTrackingCategories
arraynull
A list of linked tracking categories.
AccountingCompanyId
stringnull
The company ID the transaction belongs to
UpdateRefundResponse
object
7 properties6 required
RefundStatus
string
Status of refund. Maps to: QBO (limited status), NetSuite CashRefund status, Sage Intacct state (draft/posted/voided), Zoho Books visstate.
DepartmentId
stringnull
The ID of the department
LinkedInvoiceItem
object
3 properties
Raw
objectnull
Raw response from the integration when raw=true query param is provided
GetRefundResponse
object
7 properties6 required
CustomField
object
4 properties
CreatedBy
stringnull
The user who created the object.
Allocation
object
5 properties
LinkedTaxRate
object
4 properties
LinkedTrackingCategory
objectnull
5 properties
UnifiedId
object
A object containing a unique identifier for the resource that was created, updated, or deleted.
1 property1 required
BadRequestResponse
object
7 properties
UpdatedBy
stringnull
The user who last updated the object.
CreateRefundResponse
object
7 properties6 required
Quantity
numbernull
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Apideck Refunds API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.