Refunds Mutations

CreateRefund

Creates a new refund document.

Parameters:

Parameter	Type	Description
input	RefundInput!	Refund data.

Example Query:

GraphQL

mutation CreateRefund($input: RefundInput!) {
  CreateRefund(input: $input) {
    id
    label
    status
  }
}

---

CreateRefundFrom

Creates a refund from one or multiple Invoices or Product Returns.

Parameters:

Parameter	Type	Description
input	RefundFromInput!	Source documents IDs.

---

UpdateRefund

Updates an existing refund.

Parameters:

Parameter	Type	Description
id	Int!	ID of the refund.
input	RefundInput!	Updated data.

---

DeleteRefund / DeleteRefunds

Deletes one or multiple refunds.

---

GenerateRefundNumber

Generates the next available refund label.

---

Input Data Types

RefundInput

Field	Type	Description
id	Int	ID.
label	String	Refund number.
dated_at	Date	Document date.
status	RefundStatus	Current status.
tax_type	TaxType	Tax calculation method (Exclusive/Inclusive).
exchange_rate	Float	Exchange rate.
notes	String	Public notes.
internal_notes	String	Private notes.
season	SeasonInput	Linked season.
currency	CurrencyInput	Billing currency.
customer	CustomerInput	Associated customer.
price_level	PriceLevelInput	Price level override.
account_representative	AccountRepresentativeInput	Assigned representative.
billing_address	AddressInput	Billing address data.
pdf_template	PdfTemplateInput	PDF template configuration.
line_items	[LineItemRefundInput]	List of items refunded.
files	[FileInput]	Attachments.
custom_fields	[EntityCustomFieldInput]	Custom fields for this entity.

---

RefundFromInput

Field	Type	Description
Invoice	[Int]	Source invoices IDs.
ProductReturn	[Int]	Source product returns IDs.

---

GenerateRefundsPdfs

Generates PDF files for the specified refunds.

Parameters:

Parameter	Type	Description
ids	[ID!]!	List of refund IDs.

Example Query:

GraphQL

mutation GenerateRefundsPdfs($ids: [ID!]!) {
  GenerateRefundsPdfs(ids: $ids)
}

Return Type	Description
String	Status message.

---

Enums

RefundStatus

Value	Description
unpublished	Draft status (no impact).
pending	Document processed, payment awaiting.
refunded	Payment confirmed.
cancelled	Document voided.

TaxType

Value	Description
exclusive	Tax calculated on top of the net price.
inclusive	Tax included in the displayed price.