Customer Return

Customer Return Object

End Point
Properties - Customer Return
Properties - Ship Doc Line Item
Properties - Ship Doc Line Item Details
Json Sample

End Point

/customerreturn

GET, POST, PUT, DELETE

GET and DELETE requests expect parameter docNo of type Int32.

Properties - Customer Return

Property	Caption	Data Type	Required	Can Update with PUT
CustomerRef	Customer	EntityRef	True	False
ShipToRef	Ship To	EntityRef	False	False
DocNo	No.	Int32	False	False
CustomerPO	Customer PO	String (25)	False	False
Date	Date	DateTime	True	False
StatusRef	Status	EntityRef	False	True
TrackingNo	Tracking No.	String (50)	False	False
TotalPackages	Total Packages	Int32	False	False
ClassRef	Class	EntityRef	False	False
ContactRef	Contact	EntityRef	False	False
CurrencyRef	Currency	EntityRef	False	False
FOB	FOB	String (50)	False	True
InternalNotes	Internal Notes	String (4000)	False	True
Memo	Memo	String (4000)	False	True
LocationRef	Location	EntityRef	False	False
ItemSalesTaxRef	Sales Tax	EntityRef	False	False
DiscountRef	Discount	EntityRef	False	False
DiscountAmount	Discount Amount	Decimal	False	False
DiscountSalesTaxCodeRef	Discount Tax Code	EntityRef	False	False
ShipMethodRef	Shipping Method	EntityRef	False	True
ShipAmount	Shipping Amount	Decimal	False	True
ShipSalesTaxCodeRef	Shipping Tax Code	EntityRef	False	True
SalesRepRef	Sales Rep	EntityRef	False	False
TermRef	Terms	EntityRef	False	False
ExchangeRate	Exchange Rate	Decimal	False	False
BillAddress	Bill Address	CustomerAddress	False	False
ShipAddress	Ship Address	CustomerAddress	False	False
LineItems	Items	Array of ShipDocLineItem	False	False
CustomFields	Custom Fields	Array of CustomFieldData	False	True

Top

Properties - Ship Doc Line Item

Property	Caption	Data Type	Required	Read Only
$type	This property MUST be included to tell the API what type of item is being added. The value should be "AOLib7.ShipDocLineItem, AOLib7"
Id	Id	Int32	False	True
LineNo	Line No	Int16	False	True
ItemRef	Item	EntityRef	True	False
Description	Description	String (4000)	False	False
LineInstructions	Line Instructions	String (4000)	False	False
SalesTaxCodeRef	Tax Code	EntityRef	False	False
UomRef	UOM	EntityRef	False	False
UomConversionRate	UOM Conversion Rate	Decimal	False	False
Price	Price	Decimal	True	False
Quantity	Quantity	Decimal	True	False
StdCost	Std. Cost	Decimal	False	True
StdPrice	Std. Price	Decimal	False	True
CustomerPartNo	Customer Part No	String (50)	False	False
LinkedInfo	Links	LinkedLineItemInfo	False	False
CustomFields	Custom Fields	Array of CustomFieldData	False	False
Details	Line Item Details	Array of FillBinBase	False	False

The LinkedInfo property of type LinkedLineItemInfo is the way in which you link a ship doc line item to a customer return line item. The PromiseDate property is also included to account for Sales Orders that have multiple Promise Dates.

Property	Caption	Data Type
TranType	Tran Type	RecordTypeEnum
DocNo	Doc No	Int32
LineNo	Line No	Int16
PromiseDate	Promise Date	DateTime

Top

Properties - Ship Doc Line Item - Details

The Details node is comprised of Line Item Details. If you have used the Form Designer, you know that you can add details to show the Bins and Lot or Serial No data for inventoried items. Only inventoried items comprising of Part and Assembly items need Details. Details for non-inventoried items will be ignored. You only need to include Details if you want to specifically identify the bins and / or lot and serial numbers being included, otherwise you can omit the Details section and Order Time will automatically fill the ship doc line item with available inventory ¹. If you include Details for one Ship Doc Line item then you must do so for all inventoried Ship Doc Line Items and visa versa. You cannot have some inventoried Ship Doc Line Items with Details and some without.

Line Item Details are comprised of an Array of FillBinBase. FillBinBase can morph into either FillBin or DocFillLotOrSerial. DocFillLotOrSerial is used when the item has TrackLotOrSerial set to true and FillBin is used otherwise.

Property	Caption	Data Type	Required	Read Only	Applied to
$type	This property MUST be included to tell the API what type of Detail is being added. The value should be "AOLib7.FillBin, AOLib7" or "AOLib7.DocFillLotOrSerial, AOLib7"
Id	Id	Int32	False	True	Both
BinRef	Bin	EntityRef	True	False	Both
LotOrSerialNo	Lot Or Serial No	String (50)	True	False	DocFillLotOrSerial
ExpirationDate	Expiration Date	DateTime	True	False	DocFillLotOrSerial
Quantity	Quantity	Decimal	True	False	Both
Description	Description	String (4000)	False	False	DocFillLotOrSerial
WarrantyTypeRef	Warranty	EntityRef	False	False	DocFillLotOrSerial
WarrantyDays	Warranty Days	Int32	False	False	DocFillLotOrSerial
CustomFields	Custom Fields	Array of CustomFieldData	False	False	DocFillLotOrSerial

Top

Json Sample

{
    "CustomerRef": {
        "Id": 32
    },
    "ShipToRef": {
        "Id": 1
    },
    "Date": "2018-11-05T00:00:00",
    "LineItems": [
        {
            "$type": "AOLib7.ShipDocLineItem, AOLib7",
            "ItemRef": {
                "Id": 30
            },
            "LineNo": 1,
            "Quantity": 2,
            "LinkedInfo": {
                "LineNo": 1,
                "PromiseDate": "2018-11-14T00:00:00",
                "DocNo": 18,
                "TranType": 7
            },
            "Details": [
                {
                    "$type": "AOLib7.FillBin, AOLib7",
                    "Id": 1091,
                    "BinRef": {
                        "Id": 8,
                        "Name": "Floor"
                    },
                    "Quantity": 2
                    
                }
                ],
            "CustomFields": []
        },
        {
            "$type": "AOLib7.ShipDocLineItem, AOLib7",
            "Id": 33,
            "ItemRef": {
                "Id": 37
            },
            "Quantity": 1,
            "LinkedInfo": {
                "LineNo": 2,
                "PromiseDate": "2018-11-14T00:00:00",
                "DocNo": 18,
                "TranType": 7
            }, 
            "Details": [
               
                {
                    "$type": "AOLib7.DocFillLotOrSerial, AOLib7",
                    "BinRef": {
                        "Id": 8,
                        "Name": "Floor"
                    },
                    "Quantity": 1,
                    "LotOrSerialNo": "1253215235"
                }
                ]
           
        }
    ],
    "StatusRef": {
        "Id": 0,
        "Name": "Shipped"
    },
     "LocationRef": {
        "Id": 10,
        "Name": "HQ"
    }
}

Top

^{1 - When Details are not included Order Time will attempt to fill the sales order using its business rules and Company Preferences.}