SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

SupplierGoodsReturnNotesSimple

Supplier Module - Transaction

Supplier Goods Return Note API

Requires Authentication
Required permission:SupplierGoodsReturnNote-Transaction.GET
The following routes are available for this service:
GET/SupplierGoodsReturnNotes/simple
GET/SupplierGoodsReturnNotes/simple/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/SupplierGoodsReturnNotes/simple/GoodsReturnNote/{AcSupGoodsReturnNoteMID}Get a record by given a Document NumberHeader and Detail record would be return if found.
SupplierGoodsReturnNotesSimple Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?No
AcSupGoodsReturnNoteMIDpathstringNo
SupplierGoodsReturnNotesSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
GoodsReturnNotesformList<SupplierGoodsReturnNoteSimple>No
ResponseStatusformResponseStatusNo
SupplierGoodsReturnNoteSimple Parameters:
NameParameterData TypeRequiredDescription
DocumentHeaderformDocumentHeaderYesSupplier Goods Return Note Header - Primary Key: AcSupGoodsReturnNoteMID
DocumentDetailsformDocumentDetailsYesSupplier Goods Return Note Details - Primary Key: AcSupGoodsReturnNoteMID, ItemNo
AcSupGoodsReturnNoteMSimple Parameters:
NameParameterData TypeRequiredDescription
AcSupGoodsReturnNoteMIDformNVARCHAR(20)YesGoods Return Note Number
AcSupplierIDformNVARCHAR(20)YesSupplier ID
AcLocationIDformNVARCHAR(20)YesLocation ID
DocumentDateformDATEYesGoods Return Note Date
SupplierDONumberformNVARCHAR(20)NoSupplier DO Number
IsConsignmentINStockOnlyformNVARCHAR(1)YesIs Consignment IN Stock Only
DocumentNetAmountformNUMERIC(18,2)YesNet Amount. Before Round Cent Adjustment
DocumentCentBalanceformNUMERIC(18,2)YesRound Cent Adjustment Amount
DocumentFinalAmountformNUMERIC(18,2)YesFinal Amount. After Round Cent Adjustment
RefDocumentNoformNUMERIC(18,2)YesTotal Applied Amount. Total knock-off amount that applied to outstanding invoices.
DocumentRemarkformNVARCHAR(100)NoDocument Remark
ExtraRemark1formNVARCHAR(100)NoExtra Remark 1
ExtraRemark2formNVARCHAR(100)NoExtra Remark 2
ExtraRemark3formNVARCHAR(100)NoExtra Remark 3
ExtraRemark4formNVARCHAR(100)NoExtra Remark 4
AcSupGoodsReturnNoteDSimple Parameters:
NameParameterData TypeRequiredDescription
AcSupGoodsReturnNoteMIDformNVARCHAR(20)YesGoods Return Number
ItemNoformINTYesItem Number
AcStockIDformNVARCHAR(20)YesStock ID
AcStockUOMIDformNVARCHAR(20)YesStock UOM ID
ItemUnitPriceformNUMERIC(18,4)YesItem Unit Price
ItemQuantityformNUMERIC(18,4)YesItem Quantity
ItemGrossTotalformNUMERIC(18,2)YesItem Gross Total. [Item Unit Price] x [Item Quantity]
ItemDiscountAmountformNUMERIC(18,2)YesItem Discount Amount
ItemTotalPriceformNUMERIC(18,2)YesItem Total Price. [(Unit Price x Quantity) - Discount Amount]
ItemRemark1formNVARCHAR(MAX)YesItem Remark 1

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

HTTP + JSV

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

GET /SupplierGoodsReturnNotes/simple HTTP/1.1 
Host: snr2u.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	GoodsReturnNotes: 
	[
		{
			DocumentHeader: 
			{
				AcSupGoodsReturnNoteMID: String,
				AcSupplierID: String,
				AcLocationID: String,
				DocumentDate: 0001-01-01,
				SupplierDONumber: String,
				IsConsignmentINStockOnly: String,
				DocumentNetAmount: 0,
				DocumentCentBalance: 0,
				DocumentFinalAmount: 0,
				RefDocumentNo: String,
				DocumentRemark: String,
				ExtraRemark1: String,
				ExtraRemark2: String,
				ExtraRemark3: String,
				ExtraRemark4: String
			},
			DocumentDetails: 
			[
				{
					AcSupGoodsReturnNoteMID: String,
					ItemNo: 0,
					AcStockID: String,
					AcStockUOMID: String,
					ItemUnitPrice: 0,
					ItemQuantity: 0,
					ItemGrossTotal: 0,
					ItemDiscountAmount: 0,
					ItemTotalPrice: 0,
					ItemRemark1: String
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}