API DOCUMENTATION
    Try Unleashed Now Sandbox

    Supplier Returns

    The SupplierReturns resource allows Supplier Returns to be listed and viewed. An individual Supplier Return’s details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.

    The full range of URIs and HTTP Verbs supported are:

    Operation HTTP Action
    List a page of SupplierReturns GET /SupplierReturns/
    View a Supplier Return with the specified Guid GET /SupplierReturns/{returnGuid}

    GET SupplierReturns

    Available Filters for GET Supplier Returns
    Filter Description
    endDate Returns Supplier Returns created before a specified date.
    modifiedSince Returns Supplier Returns created or edited after a specified date, must be UTC format.
    pageSize Specifies the page size for pagination. Default page size is 200 Supplier Returns.

    Note: Requesting large numbers of supplier returns can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
    purchaseOrderNumber Returns the supplier return(s) associated with the specified purchase order number.
    startDate Returns Supplier Returns created after a specified date.
    supplierCode Returns customers that start with the specific customer code.
    supplierReturnNumber Returns a single supplier return with the specified supplier return number. If set, it overrides all other filters.
    Note: Date filters should be provided in the ISO format YYYY-MM-DD.

    Filters are used by adding the filter and value to the URI:
    • /SupplierReturns?supplierCode=ACME&startDate=2012-12-31
    Available Fields for Supplier Returns
    Property Type Length
    BaseReturnCostTaxTotal Decimal
    BaseReturnCostTotal Decimal
    BaseSubTotal Decimal
    BaseTaxTotal Decimal
    BaseTotal Decimal
    Comments String 1024
    CreatedBy String 50
    CreatedOn DateTime
    Currency Currency
    ExchangeRate Nullable Decimal
    Guid Guid
    LastModifiedBy String 50
    LastModifiedOn Nullable DateTime
    PurchaseOrder PurchaseOrder
    ReturnDate Nullable DateTime
    Status String 20
    SubTotal Decimal
    Supplier Supplier
    SupplierRef String 500
    SupplierReturnCosts SupplierReturnCost Collection
    SupplierReturnLines SupplierReturnLine Collection
    SupplierReturnNumber String 20
    TaxRate Nullable Decimal
    TaxTotal Decimal
    Total Decimal
    Warehouse Warehouse
    XeroTaxCode String 50
    Available Fields for Supplier Return Lines
    Property Type Length
    AverageLandedPriceAfterReturn Nullable Decimal
    AverageLandedPriceBeforeReturn Nullable Decimal
    Comments String 1024
    Guid Guid
    LineNumber Int
    LineTax Nullable Decimal
    OrderPrice Decimal
    OrderQuantity Decimal
    Product Product
    PurchaseUnitOrderQuantity Decimal
    PurchaseUnitReturnQuantity Decimal
    RequiredDate DateTime
    ReturnCost Decimal
    ReturnPrice Decimal
    ReturnQuantity Decimal
    ReturnReason String 25
    ReturnToSupplier Boolean
    StockOnHandBeforeReturn Nullable Decimal
    TaxRate Nullable Decimal
    XeroCostOfGoodsAccount String 500
    XeroSalesAccount String 500
    XeroTaxCode String 50
    Available Fields for Supplier Return Costs
    Property Type Length
    BCCost Decimal
    BCTaxCost Decimal
    BCTotalCost Decimal
    Cost Decimal
    CostDate DateTime
    ExchangeRate Nullable Decimal
    Guid Guid
    Refund Boolean
    Supplier Supplier
    TaxCode String 50
    TaxCost Decimal
    TaxRate Nullable Decimal
    TotalCost Decimal
    Available Fields for Currency
    Property Type Length
    CurrencyCode String 3
    Description String 200
    Guid Guid
    LastModifiedOn DateTime
    Available Fields for Product
    Property Type Length
    Guid Guid
    ProductCode String 100
    ProductDescription String 500
    Available Fields for Purchase Order
    Property Type Length
    Guid Guid
    OrderDate DateTime
    OrderNumber String 20
    Available Fields for Supplier
    Property Type Length
    Guid Guid
    SupplierCode String 500
    SupplierName String 500
    Available Fields for Warehouse
    Property Type Length
    Guid Guid
    WarehouseCode String 15
    WarehouseName String 100

    Examples for Response GET /SupplierReturns

    show xml example
    show json example

    Use the API Sandbox to see how the object is rendered in JSON or XML.

    Note: An Unleashed account is required before you can use the API Sandbox.

    Trial accounts are also allowed to connect to the API.
    You can register a new account here: Register.