Vendor Return

Vendor Return Object

Vendor Return is the opposite of a Receiver. Like all transactions it is comprised of a Doc portion (Receiver) and one or more Line Items (ReceiverLineItem). ReceiverLineItem may optionally include one or more Details.

End Point
Properties - Vendor Return
Properties - Receiver Line Item
Properties - Receiver Line Item Details
Json Sample

End Point

/receiver

GET, POST, DELETE

GET and DELETE requests expect parameter docNo of type Int32.

Top

Properties - Receiver

Property	Caption	Data Type	Required
VendoorRef	Vendor	EntityRef	True
BillAddressRef	Bill To	EntityRef	False
DocNo	No.	Int32	False
Date	Date	DateTime	True
ExpectedDate	Expected Date	DateTime	False
StatusRef	Status	EntityRef	False
TrackingNo	Tracking No.	String (50)	False
TotalWeight	Total Weight	Decimal	False
TotalPackages	Total Packages	Int32	False
ClassRef	Class	EntityRef	False
CurrencyRef	Currency	EntityRef	False
FOB	FOB	String (50)	False
InternalNotes	Internal Notes	String (4000)	False
Memo	Memo	String (4000)	False
LocationRef	Location	EntityRef	False
TermRef	Terms	EntityRef	False
ExchangeRate	Exchange Rate	Decimal	False
LineItems	Items	Array of ReceiverLineItem	False
CustomFields	Custom Fields	Array of CustomFieldData	False

Top

Properties - Receiver 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.ReceiverLineItem, 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
Cost	Cost	Decimal	True	False
Quantity	Quantity	Decimal	True if no details are provided	False
VendorPartNo	Part No	Sting(5)	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 sales order line item to a ship doc line item. The PromiseDate property is also included to account for Purchase 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 - Receiver 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. If you include Details for one Receiver Line item then you must do so for all inventoried Receiver Line Items and visa versa. You cannot have some inventoried Receiver 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

{
    "VendorRef": {
        "Id": 32
    },
    "BillAddressRef": {
        "Id": 1
    },
    "Date": "2018-11-05T00:00:00",
    "LineItems": [
        {
            "$type": "AOLib7.ReceiverLineItem, AOLib7",
            "ItemRef": {
                "Id": 30
            },
            "LineNo": 1,
            "Quantity": 2,
            
            "Details": [
                {
                    "$type": "AOLib7.FillBin, AOLib7",
                    "Id": 1091,
                    "BinRef": {
                        "Id": 8,
                        "Name": "Floor"
                    },
                    "Quantity": 2
                    
                }
                ],
            "CustomFields": []
        },
        {
            "$type": "AOLib7.ReceiverLineItem, AOLib7",
            "Id": 33,
            "ItemRef": {
                "Id": 37
            },
            "Quantity": 1,
           
            "Details": [
               
                {
                    "$type": "AOLib7.DocFillLotOrSerial, AOLib7",
                    "BinRef": {
                        "Id": 8,
                        "Name": "Floor"
                    },
                    "Quantity": 1,
                    "LotOrSerialNo": "1253215235"
                }
                ]
           
        }
    ],
    "StatusRef": {
        "Id": 60,
        "Name": "In Transit"
    },
     "LocationRef": {
        "Id": 10,
        "Name": "HQ"
    }
}

Top