Required permission: | SupplierGoodsReturnNote-Transaction.GET |
GET | /SupplierGoodsReturnNotes/simple | ||
---|---|---|---|
GET | /SupplierGoodsReturnNotes/simple/page/{Page} | Get records by given a page number | Each page consists of 20 records |
GET | /SupplierGoodsReturnNotes/simple/GoodsReturnNote/{AcSupGoodsReturnNoteMID} | Get a record by given a Document Number | Header and Detail record would be return if found. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Page | path | int? | No | |
AcSupGoodsReturnNoteMID | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GoodsReturnNotes | form | List<SupplierGoodsReturnNoteSimple> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DocumentHeader | form | DocumentHeader | Yes | Supplier Goods Return Note Header - Primary Key: AcSupGoodsReturnNoteMID |
DocumentDetails | form | DocumentDetails | Yes | Supplier Goods Return Note Details - Primary Key: AcSupGoodsReturnNoteMID, ItemNo |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupGoodsReturnNoteMID | form | NVARCHAR(20) | Yes | Goods Return Note Number |
AcSupplierID | form | NVARCHAR(20) | Yes | Supplier ID |
AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
DocumentDate | form | DATE | Yes | Goods Return Note Date |
SupplierDONumber | form | NVARCHAR(20) | No | Supplier DO Number |
IsConsignmentINStockOnly | form | NVARCHAR(1) | Yes | Is Consignment IN Stock Only |
DocumentNetAmount | form | NUMERIC(18,2) | Yes | Net Amount. Before Round Cent Adjustment |
DocumentCentBalance | form | NUMERIC(18,2) | Yes | Round Cent Adjustment Amount |
DocumentFinalAmount | form | NUMERIC(18,2) | Yes | Final Amount. After Round Cent Adjustment |
RefDocumentNo | form | NUMERIC(18,2) | Yes | Total Applied Amount. Total knock-off amount that applied to outstanding invoices. |
DocumentRemark | form | NVARCHAR(100) | No | Document Remark |
ExtraRemark1 | form | NVARCHAR(100) | No | Extra Remark 1 |
ExtraRemark2 | form | NVARCHAR(100) | No | Extra Remark 2 |
ExtraRemark3 | form | NVARCHAR(100) | No | Extra Remark 3 |
ExtraRemark4 | form | NVARCHAR(100) | No | Extra Remark 4 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AcSupGoodsReturnNoteMID | form | NVARCHAR(20) | Yes | Goods Return Number |
ItemNo | form | INT | Yes | Item Number |
AcStockID | form | NVARCHAR(20) | Yes | Stock ID |
AcStockUOMID | form | NVARCHAR(20) | Yes | Stock UOM ID |
ItemUnitPrice | form | NUMERIC(18,4) | Yes | Item Unit Price |
ItemQuantity | form | NUMERIC(18,4) | Yes | Item Quantity |
ItemGrossTotal | form | NUMERIC(18,2) | Yes | Item Gross Total. [Item Unit Price] x [Item Quantity] |
ItemDiscountAmount | form | NUMERIC(18,2) | Yes | Item Discount Amount |
ItemTotalPrice | form | NUMERIC(18,2) | Yes | Item Total Price. [(Unit Price x Quantity) - Discount Amount] |
ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } } }