POS365.VN APIs

ReturnGet

**Requires Authentication**
Required permission:	Return_Read

The following routes are available for this service:
GET	/api/returns/{Id}

**ReturnGet** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	long	No
Includes	query	string[]	No

**Return** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Code	form	string	No
BranchId	form	int	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
Status	form	byte	No
Description	form	string	No
RetailerId	form	int	No
OrderId	form	long?	No
ReturnDate	form	DateTime	No
PartnerId	form	long?	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
Total	form	decimal	No
Discount	form	decimal?	No
AccountId	form	int?	No
TotalPayment	form	decimal	No
Account	form	Account	No
Order	form	Order	No
Partner	form	Partner	No
ReturnDetails	form	ICollection<ReturnDetail>	No

**Account** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Description	form	string	No
RetailerId	form	int	No
CreatedBy	form	long	No
CreatedDate	form	DateTime	No
ModifiedBy	form	long?	No
ModifiedDate	form	DateTime?	No

**Order** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Code	form	string	No
PurchaseDate	form	DateTime	No
EndPurchaseDate	form	DateTime?	No
BranchId	form	int	No
Description	form	string	No
Status	form	byte	No
ModifiedDate	form	DateTime?	No
RetailerId	form	int	No
Discount	form	decimal?	No
SoldById	form	long?	No
RoomId	form	long?	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedBy	form	long?	No
DiscountToView	form	string	No
Total	form	decimal	No
TotalPayment	form	decimal	No
TotalAdditionalServices	form	decimal	No
PartnerId	form	long?	No
ExcessCash	form	decimal?	No
AmountReceived	form	decimal	No
ShippingCost	form	decimal	No
PriceBookId	form	long?	No
AccountId	form	int?	No
Pos	form	string	No
NumberOfGuests	form	int	No
VAT	form	decimal	No
Voucher	form	decimal	No
MoreAttributes	form	string	No
ChannelId	form	long?	No
TaxPrivateCode	form	string	No
EInvoiceRequestType	form	EInvoiceRequestType	No
SyncEInvoice	form	bool	No
Account	form	Account	No
Channel	form	OrderChannel	No
Partner	form	Partner	No
PriceBook	form	PriceBook	No
Room	form	Room	No
DuplicateId	form	Guid?	No
OrderDetails	form	ICollection<OrderDetail>	No
VATInvoices	form	ICollection<VATInvoice>	No
IsAeonMallReport	form	bool?	No

**EInvoiceRequestType** Enum:
NotExport
WaitForExport
ExportImmediately

**OrderChannel** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
Image	form	string	No
RetailerId	form	int	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No

**Partner** Parameters:
Name	Parameter	Data Type	Required
PlainPassword	form	string	No
Id	form	long	No
Code	form	string	No
Name	form	string	No
Address	form	string	No
Phone	form	string	No
DOB	form	DateTime?	No
Email	form	string	No
Type	form	byte	No
Gender	form	byte	No
TaxCode	form	string	No
TotalDebt	form	decimal	No
Loyalty	form	decimal	No
Description	form	string	No
CreatedBy	form	long	No
CreatedDate	form	DateTime	No
ModifiedBy	form	long?	No
ModifiedDate	form	DateTime?	No
RetailerId	form	int	No
Image	form	string	No
IdentifyNo	form	string	No
LeadOwnerId	form	long?	No
Company	form	string	No
Department	form	string	No
Password	form	string	No
Province	form	string	No
Point	form	long	No
ShippingAddress	form	string	No
Phone2	form	string	No
MemberJoinDate	form	DateTime?	No
Transactionvalue	form	decimal	No
LeadOwner	form	User	No
PartnerGroupMembers	form	ICollection<PartnerGroupMember>	No

**User** Parameters:
Name	Parameter	Data Type	Required
PlainPassword	form	string	No
Id	form	long	No
Email	form	string	No
UserName	form	string	No
Password	form	string	No
Name	form	string	No
DOB	form	DateTime?	No
Address	form	string	No
Phone	form	string	No
CreatedDate	form	DateTime	No
IsActive	form	bool	No
IsAdmin	form	bool	No
RetailerId	form	int	No
CreatedBy	form	long	No
AdminGroup	form	byte	No
ManagedBy	form	long?	No
IdentityCardNumber	form	string	No
ManagedByNavigation	form	User	No

**PartnerGroupMember** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
PartnerId	form	long	No
GroupId	form	long	No

**PriceBook** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
IsActive	form	bool	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
RetailerId	form	int	No
StartDate	form	DateTime	No
EndDate	form	DateTime	No
LimitUsers	form	string	No
LimitBranchs	form	string	No
LimitCustomerGroups	form	string	No
PriceBookDetails	form	ICollection<PriceBookDetail>	No

**PriceBookDetail** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
PriceBookId	form	long	No
ProductId	form	long	No
Price	form	decimal	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
PriceLargeUnit	form	decimal	No
Product	form	Product	No

**Product** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Code	form	string	No
Name	form	string	No
AttributesName	form	string	No
CategoryId	form	long?	No
Description	form	string	No
Price	form	decimal	No
PriceLargeUnit	form	decimal	No
ProductType	form	byte	No
ConversionValue	form	double	No
Unit	form	string	No
LargeUnit	form	string	No
IsSerialNumberTracking	form	bool	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
RetailerId	form	int	No
IsPercentageOfTotalOrder	form	bool	No
SplitForSalesOrder	form	bool	No
OrderQuickNotes	form	string	No
Printer	form	string	No
Hidden	form	bool?	No
IsTimer	form	bool?	No
Coefficient	form	double?	No
BonusPoint	form	double	No
ShowOnBranchId	form	string	No
BonusPointForAssistant	form	double	No
BonusPointForAssistant2	form	double	No
BonusPointForAssistant3	form	double	No
PriceConfig	form	string	No
BlockOfTimeToUseService	form	int	No
IsPriceForBlock	form	bool	No
Formular	form	string	No
Position	form	long	No
LargeUnitCode	form	string	No
Code2	form	string	No
Code3	form	string	No
Code4	form	string	No
Code5	form	string	No
ThirdUnitConversionValue	form	double	No
ThirdUnit	form	string	No
Category	form	Category	No
CompositeItemProducts	form	ICollection<CompositeItem>	No
ProductAttributes	form	ICollection<ProductAttribute>	No
ProductImages	form	ICollection<ProductImage>	No

**Category** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
ImageURL	form	string	No
Description	form	string	No
ParentId	form	long?	No
RetailerId	form	int	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
ShowOnBranchId	form	string	No
Position	form	long	No
Parent	form	Category	No

**CompositeItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ProductId	form	long	No
ItemId	form	long	No
Quantity	form	double	No
RetailerId	form	int	No
QuantityLargeUnit	form	double	No
Item	form	Product	No

**ProductAttribute** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ProductId	form	long	No
AttributeName	form	string	No
AttributeValue	form	string	No
RetailerId	form	int	No

**ProductImage** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ProductId	form	long	No
ImageURL	form	string	No
ThumbnailUrl	form	string	No
IsDefault	form	bool	No

**Room** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
Position	form	int	No
BranchId	form	int	No
RetailerId	form	int	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedBy	form	long?	No
ModifiedDate	form	DateTime?	No
Description	form	string	No
ProductId	form	long?	No
RoomGroupId	form	long?	No
Printer	form	string	No
QRCode	form	string	No
Config	form	string	No
Product	form	Product	No
RoomGroup	form	RoomGroup	No

**RoomGroup** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
BranchId	form	int	No
RetailerId	form	int	No

**OrderDetail** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
OrderId	form	long	No
ProductId	form	long	No
Quantity	form	double	No
Price	form	decimal	No
BasePrice	form	decimal	No
SerialNumbers	form	string	No
Description	form	string	No
ComboItems	form	string	No
IsLargeUnit	form	bool	No
ConversionValue	form	double	No
Spreadsheets	form	string	No
Coefficient	form	double?	No
ExpiryDate	form	DateTime?	No
Topping	form	string	No
Processed	form	double	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
StartTimingFrom	form	DateTime?	No
SoldById	form	long?	No
AssistantById	form	long?	No
AssistantById2	form	long?	No
AssistantById3	form	long?	No
IsPromotion	form	bool	No
Name	form	string	No
Code	form	string	No
MoreAttributes	form	string	No
Product	form	Product	No

**VATInvoice** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
OrderId	form	long	No
Key_Rec	form	string	No
SignedDate	form	DateTime	No
SignValue	form	string	No
ProviderCode	form	string	No
MaCQT	form	string	No
Pattern	form	string	No
Serial	form	string	No
InvoiceNo	form	string	No
UrlSearch	form	string	No
KeySearch	form	string	No
RawData	form	string	No
Data	form	string	No
BranchId	form	int	No
RetailerId	form	int	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedBy	form	long?	No
ModifiedDate	form	DateTime?	No
Description	form	string	No
InvoiceChannel	form	int	No
ErrorMessage	form	string	No
Status	form	int	No

**ReturnDetail** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ReturnId	form	long	No
ProductId	form	long	No
Quantity	form	double	No
Price	form	decimal	No
SerialNumbers	form	string	No
IsLargeUnit	form	bool	No
ComboItems	form	string	No
ConversionValue	form	double	No
ExpiryDate	form	DateTime?	No
Description	form	string	No
Product	form	Product	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/returns/{Id} HTTP/1.1 
Host: api.pos365.vn 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Code":"String","BranchId":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"Status":0,"Description":"String","RetailerId":0,"OrderId":0,"ReturnDate":"0001-01-01T00:00:00.0000000Z","PartnerId":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"Total":0,"Discount":0,"AccountId":0,"TotalPayment":0,"Account":{"Id":0,"Name":"String","Description":"String","RetailerId":0,"CreatedBy":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z"},"Order":{"Id":0,"Code":"String","PurchaseDate":"0001-01-01T00:00:00.0000000Z","EndPurchaseDate":"0001-01-01T00:00:00.0000000Z","BranchId":0,"Description":"String","Status":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","RetailerId":0,"Discount":0,"SoldById":0,"RoomId":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedBy":0,"DiscountToView":"String","Total":0,"TotalPayment":0,"TotalAdditionalServices":0,"PartnerId":0,"ExcessCash":0,"AmountReceived":0,"ShippingCost":0,"PriceBookId":0,"AccountId":0,"Pos":"String","NumberOfGuests":0,"VAT":0,"Voucher":0,"MoreAttributes":"String","ChannelId":0,"TaxPrivateCode":"String","EInvoiceRequestType":"NotExport","SyncEInvoice":false,"Account":{"Id":0,"Name":"String","Description":"String","RetailerId":0,"CreatedBy":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z"},"Channel":{"Id":0,"Name":"String","Image":"String","RetailerId":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0},"Partner":{"PlainPassword":"String","Id":0,"Code":"String","Name":"String","Address":"String","Phone":"String","DOB":"0001-01-01T00:00:00.0000000Z","Email":"String","Type":0,"Gender":0,"TaxCode":"String","TotalDebt":0,"Loyalty":0,"Description":"String","CreatedBy":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","RetailerId":0,"Image":"String","IdentifyNo":"String","LeadOwnerId":0,"Company":"String","Department":"String","Password":"String","Province":"String","Point":0,"ShippingAddress":"String","Phone2":"String","MemberJoinDate":"0001-01-01T00:00:00.0000000Z","Transactionvalue":0,"LeadOwner":{"PlainPassword":"String","Id":0,"Email":"String","UserName":"String","Password":"String","Name":"String","DOB":"0001-01-01T00:00:00.0000000Z","Address":"String","Phone":"String","CreatedDate":"0001-01-01T00:00:00.0000000Z","IsActive":false,"IsAdmin":false,"RetailerId":0,"CreatedBy":0,"AdminGroup":0,"ManagedBy":0,"IdentityCardNumber":"String","ManagedByNavigation":{"PlainPassword":"String","Id":0,"Email":"String","UserName":"String","Password":"String","Name":"String","DOB":"0001-01-01T00:00:00.0000000Z","Address":"String","Phone":"String","CreatedDate":"0001-01-01T00:00:00.0000000Z","IsActive":false,"IsAdmin":false,"RetailerId":0,"CreatedBy":0,"AdminGroup":0,"ManagedBy":0,"IdentityCardNumber":"String","ManagedByNavigation":{"PlainPassword":"String","Id":0,"Email":"String","UserName":"String","Password":"String","Name":"String","DOB":"0001-01-01T00:00:00.0000000Z","Address":"String","Phone":"String","CreatedDate":"0001-01-01T00:00:00.0000000Z","IsActive":false,"IsAdmin":false,"RetailerId":0,"CreatedBy":0,"AdminGroup":0,"ManagedBy":0,"IdentityCardNumber":"String"}}}},"PriceBook":{"Id":0,"Name":"String","IsActive":false,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"RetailerId":0,"StartDate":"0001-01-01T00:00:00.0000000Z","EndDate":"0001-01-01T00:00:00.0000000Z","LimitUsers":"String","LimitBranchs":"String","LimitCustomerGroups":"String"},"Room":{"Id":0,"Name":"String","Position":0,"BranchId":0,"RetailerId":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","Description":"String","ProductId":0,"RoomGroupId":0,"Printer":"String","QRCode":"String","Config":"String","Product":{"Id":0,"Code":"String","Name":"String","AttributesName":"String","CategoryId":0,"Description":"String","Price":0,"PriceLargeUnit":0,"ProductType":0,"ConversionValue":0,"Unit":"String","LargeUnit":"String","IsSerialNumberTracking":false,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"RetailerId":0,"IsPercentageOfTotalOrder":false,"SplitForSalesOrder":false,"OrderQuickNotes":"String","Printer":"String","Hidden":false,"IsTimer":false,"Coefficient":0,"BonusPoint":0,"ShowOnBranchId":"String","BonusPointForAssistant":0,"BonusPointForAssistant2":0,"BonusPointForAssistant3":0,"PriceConfig":"String","BlockOfTimeToUseService":0,"IsPriceForBlock":false,"Formular":"String","Position":0,"LargeUnitCode":"String","Code2":"String","Code3":"String","Code4":"String","Code5":"String","ThirdUnitConversionValue":0,"ThirdUnit":"String","Category":{"Id":0,"Name":"String","ImageURL":"String","Description":"String","ParentId":0,"RetailerId":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"ShowOnBranchId":"String","Position":0,"Parent":{"Id":0,"Name":"String","ImageURL":"String","Description":"String","ParentId":0,"RetailerId":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"ShowOnBranchId":"String","Position":0,"Parent":{"Id":0,"Name":"String","ImageURL":"String","Description":"String","ParentId":0,"RetailerId":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"ShowOnBranchId":"String","Position":0}}}},"RoomGroup":{"Id":0,"Name":"String","CreatedDate":"0001-01-01T00:00:00.0000000Z","CreatedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"BranchId":0,"RetailerId":0}},"DuplicateId":"00000000000000000000000000000000","IsAeonMallReport":false},"Partner":{"PlainPassword":"String","Id":0,"Code":"String","Name":"String","Address":"String","Phone":"String","DOB":"0001-01-01T00:00:00.0000000Z","Email":"String","Type":0,"Gender":0,"TaxCode":"String","TotalDebt":0,"Loyalty":0,"Description":"String","CreatedBy":0,"CreatedDate":"0001-01-01T00:00:00.0000000Z","ModifiedBy":0,"ModifiedDate":"0001-01-01T00:00:00.0000000Z","RetailerId":0,"Image":"String","IdentifyNo":"String","LeadOwnerId":0,"Company":"String","Department":"String","Password":"String","Province":"String","Point":0,"ShippingAddress":"String","Phone2":"String","MemberJoinDate":"0001-01-01T00:00:00.0000000Z","Transactionvalue":0,"LeadOwner":{"PlainPassword":"String","Id":0,"Email":"String","UserName":"String","Password":"String","Name":"String","DOB":"0001-01-01T00:00:00.0000000Z","Address":"String","Phone":"String","CreatedDate":"0001-01-01T00:00:00.0000000Z","IsActive":false,"IsAdmin":false,"RetailerId":0,"CreatedBy":0,"AdminGroup":0,"ManagedBy":0,"IdentityCardNumber":"String","ManagedByNavigation":{"PlainPassword":"String","Id":0,"Email":"String","UserName":"String","Password":"String","Name":"String","DOB":"0001-01-01T00:00:00.0000000Z","Address":"String","Phone":"String","CreatedDate":"0001-01-01T00:00:00.0000000Z","IsActive":false,"IsAdmin":false,"RetailerId":0,"CreatedBy":0,"AdminGroup":0,"ManagedBy":0,"IdentityCardNumber":"String","ManagedByNavigation":{"PlainPassword":"String","Id":0,"Email":"String","UserName":"String","Password":"String","Name":"String","DOB":"0001-01-01T00:00:00.0000000Z","Address":"String","Phone":"String","CreatedDate":"0001-01-01T00:00:00.0000000Z","IsActive":false,"IsAdmin":false,"RetailerId":0,"CreatedBy":0,"AdminGroup":0,"ManagedBy":0,"IdentityCardNumber":"String"}}}}}