Name Description Type Additional information
SalesReturnID

The unique internal identifier of each sales return in Tradevine e.g. 3451582911653885586

integer

Optional

OrganisationID

The internal identifier of this organisation in Tradevine e.g. 3451460443781171981

integer

Optional

CustomerID

The unique internal identifier of each customer in Tradevine e.g. 34515829112467586585

integer

Optional

ReturnNumber

The more user friendly identifier for the order (normally auto-generated using your auto-numbering settings) e.g. SR167

string

Optional

CustomerOrderReference

The reference that the buyer for this sales order will have i.e. for Trade Me orders this will be the purchase ID e.g. P54645, for Shopify orders it will be the order number #1001

string

Optional

Status

The return status lookup value

integer

Optional

SalesOrderID

The internal identifier of the sales order this return was generated from and linked to

integer

Optional

OrderNumber

The more user friendly identifier for the order (normally auto-generated using your auto-numbering settings) e.g. SO453

string

Optional

CustomerBillingAddressID

The internal identifier of the customer's billing address in Tradevine e.g. 3451460547437456

integer

Optional

Currency

The return currency lookup value

integer

Optional

ApplyTaxes

Whether tax is applicable for this return (defaulted according to seller tax-status and buyer billing address location)

boolean

Optional

TotalsTaxInclusive

Whether totals include tax

boolean

Optional

TotalCost

The total cost value of the return (excluding tax)

decimal number

Optional

TotalCostExShipping

The total cost value of the return minus costs for shipping (excluding tax)

decimal number

Optional

GrossProfit

The total gross profit value of the return

decimal number

Optional

GrossProfitExShipping

The total gross profit value of the return minus any p/l for shipping

decimal number

Optional

GrossMarginPercent

The total gross margin percent value of the return

decimal number

Optional

GrossMarginPercentExShipping

The total gross margin percent value of the return excluding shipping margin

decimal number

Optional

AverageMarkupPercent

The average mark-up percent of the return

decimal number

Optional

AverageMarkupPercentExShipping

The average mark-up percent of the return excluding shipping mark-up

decimal number

Optional

SubTotal

The sub-total of the return (excluding taxes)

decimal number

Optional

SubTotalIncTax

The sub-total of the return including deduction for any discount

decimal number

Optional

TotalDiscount

The total of the return discount

decimal number

Optional

DiscountTax

The tax applicable to the discount component

decimal number

Optional

SubTotalExShipping

The sub-total of the return (excluding taxes and shipping)

decimal number

Optional

SubTotalApplicableTaxes

The sub total of all tax values for the return

decimal number

Optional

GrandTotal

The overall return total to be paid

decimal number

Optional

GrandTotalExShipping

The overall return total excluding shipping

decimal number

Optional

InternalNotes

Private notes associated with the return

string

Optional

ExternalNotes

Public notes associated with the return

string

Optional

CompletedDate

The date/time (in UTC) that the return moved to the Completed status

date

Optional

AccountingCreditNoteID

The internal Xero credit note identifier if integrated with Xero and the invoice has been credited

string

Optional

CreatedDate

The date and time (in UTC) that the return was created

date

Optional

CreatedBy

The internal Tradevine ID of the user that created the return

integer

Optional

ModifiedDate

The date and time (in UTC) that the return was last modified

date

Optional

ModifiedBy

The internal Tradevine ID of the user that last modified the return

integer

Optional

AccountingJournalID

If Xero is integrated, this is the ID of the manual journal created when the return was completed e.g. 1EC6091E-8B8F-4959-9B5C-D5CDCE659D6F

string

Optional

WarehouseID

Internal Tradevine ID of warehouse allocated for return

integer

Optional

WarehouseCode

Code for warehouse allocated for return

string

Optional

WarehouseAddressID

integer

Optional

Customer

Customer

Optional

BillingAddress

Address

Optional

SalesReturnLines

Collection of SalesReturnLine

Optional

Labels

Collection of string

Optional