Skip to content

RefundInput.md

Latest commit

 

History

History
39 lines (36 loc) · 50.1 KB

RefundInput.md

File metadata and controls

39 lines (36 loc) · 50.1 KB

RefundInput

Fields

Field Type Required Description Example
Number string ➖ Reference number for the refund. RF-00001
Customer LinkedCustomerInput ➖ The customer this entity is linked to.
CompanyId string ➖ The company ID the transaction belongs to 12345
Currency Currency ➖ Indicates the associated currency for an amount of money. Values correspond to ISO 4217. USD
CurrencyRate double ➖ Currency Exchange Rate at the time entity was recorded/generated. 0.69
TaxInclusive bool ➖ Amounts are including tax true
SubTotal double ➖ Subtotal amount, normally before tax. 250
TotalAmount double ✔️ The total amount of the transaction or record 49.99
TotalTax double ➖ Total tax amount applied to this transaction. 25
RefundDate DateTime ➖ The date of the refund - YYYY-MM-DDThh:mm:ss.sTZD 2021-05-01T12:00:00.000Z
Status RefundStatus ➖ Status of refund. Maps to: QBO (limited status), NetSuite CashRefund status, Sage Intacct state (draft/posted/voided), Zoho Books vis_state. paid
Type RefundType ➖ Type of refund. refund_receipt for itemized refunds with product/service lines and payment (QBO RefundReceipt, NetSuite CashRefund). cash_refund for cash-out refunds with GL distribution or allocations (Sage Intacct). credit_note_refund for refunds applied against a credit note (Zoho Books). refund_receipt
PaymentMethod string ➖ Payment method used for the transaction, such as cash, credit card, bank transfer, or check cash
PaymentMethodReference string ➖ Optional reference message returned by payment method on processing 123456
PaymentMethodId string ➖ A unique identifier for an object. 12345
Account LinkedLedgerAccount ➖ N/A
LineItems List<InvoiceLineItemInput> ➖ Line items for itemized refunds (type: refund_receipt). Used when the refund includes product/service details with quantities and pricing. Supported by QBO RefundReceipt and NetSuite CashRefund.
Allocations List<AllocationInput> ➖ Allocations linking refund to existing documents (invoices, credit notes, overpayments). Used for credit_note_refund and cash_refund types where the refund is applied against prior transactions. Supported by Sage Intacct and Zoho Books.
TaxCode string ➖ Applicable tax id/code override if tax is not supplied on a line item basis. 1234
DiscountPercentage double ➖ Discount percentage applied to this refund. 5.5
DiscountAmount double ➖ Discount amount applied to this refund. 25
Note string ➖ Optional note to be associated with the refund. Refund for returned items
CustomerMemo string ➖ Customer memo Thank you for your business and have a great day!
Reference string ➖ Optional reference message for the refund. REF-123456
BillingAddress Address ➖ N/A
ShippingAddress Address ➖ N/A
Department LinkedDepartmentInput ➖ N/A
Location LinkedLocationInput ➖ N/A
TrackingCategories List<LinkedTrackingCategory> ➖ A list of linked tracking categories.
CustomFields List<CustomField> ➖ N/A
RowVersion string ➖ 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. 1-12345
PassThrough List<PassThroughBody> ➖ The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.