SmartAcc DynaMod Web API v2024.4 Build 0000

CreateSupplierGoodsReturnNoteSimple

Supplier Module - Transaction

Supplier Goods Return Note API

**Requires Authentication**
Required permission:	SupplierGoodsReturnNote-Transaction.ADD

The following routes are available for this service:
POST	/SupplierGoodsReturnNotes/simple	Create a record for Supplier Goods Return Note	AcSupGoodsReturnNoteMID is a primary key

**CreateSupplierGoodsReturnNoteSimple** Parameters:
Name	Parameter	Data Type	Required	Description
SupplierGoodsReturnNote	body	SupplierGoodsReturnNoteSimple	No

**SupplierGoodsReturnNoteSimple** Parameters:
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

**AcSupGoodsReturnNoteMSimple** Parameters:
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

**AcSupGoodsReturnNoteDSimple** Parameters:
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

**CreateSupplierGoodsReturnNoteSimpleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SupplierGoodsReturnNote	form	SupplierGoodsReturnNoteSimple	No
ResponseStatus	form	ResponseStatus	No

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

HTTP + XML

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

POST /SupplierGoodsReturnNotes/simple HTTP/1.1 
Host: snr2u.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateSupplierGoodsReturnNoteSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <SupplierGoodsReturnNote xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:DocumentDetails>
      <d2p1:AcSupGoodsReturnNoteDSimple>
        <d2p1:AcStockID>String</d2p1:AcStockID>
        <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
        <d2p1:AcSupGoodsReturnNoteMID>String</d2p1:AcSupGoodsReturnNoteMID>
        <d2p1:ItemDiscountAmount>0</d2p1:ItemDiscountAmount>
        <d2p1:ItemGrossTotal>0</d2p1:ItemGrossTotal>
        <d2p1:ItemNo>0</d2p1:ItemNo>
        <d2p1:ItemQuantity>0</d2p1:ItemQuantity>
        <d2p1:ItemRemark1>String</d2p1:ItemRemark1>
        <d2p1:ItemTotalPrice>0</d2p1:ItemTotalPrice>
        <d2p1:ItemUnitPrice>0</d2p1:ItemUnitPrice>
      </d2p1:AcSupGoodsReturnNoteDSimple>
    </d2p1:DocumentDetails>
    <d2p1:DocumentHeader>
      <d2p1:AcLocationID>String</d2p1:AcLocationID>
      <d2p1:AcSupGoodsReturnNoteMID>String</d2p1:AcSupGoodsReturnNoteMID>
      <d2p1:AcSupplierID>String</d2p1:AcSupplierID>
      <d2p1:DocumentCentBalance>0</d2p1:DocumentCentBalance>
      <d2p1:DocumentDate>0001-01-01T00:00:00</d2p1:DocumentDate>
      <d2p1:DocumentFinalAmount>0</d2p1:DocumentFinalAmount>
      <d2p1:DocumentNetAmount>0</d2p1:DocumentNetAmount>
      <d2p1:DocumentRemark>String</d2p1:DocumentRemark>
      <d2p1:ExtraRemark1>String</d2p1:ExtraRemark1>
      <d2p1:ExtraRemark2>String</d2p1:ExtraRemark2>
      <d2p1:ExtraRemark3>String</d2p1:ExtraRemark3>
      <d2p1:ExtraRemark4>String</d2p1:ExtraRemark4>
      <d2p1:IsConsignmentINStockOnly>String</d2p1:IsConsignmentINStockOnly>
      <d2p1:RefDocumentNo>String</d2p1:RefDocumentNo>
      <d2p1:SupplierDONumber>String</d2p1:SupplierDONumber>
    </d2p1:DocumentHeader>
  </SupplierGoodsReturnNote>
</CreateSupplierGoodsReturnNoteSimple>

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

<CreateSupplierGoodsReturnNoteSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SupplierGoodsReturnNote xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:DocumentDetails>
      <d2p1:AcSupGoodsReturnNoteDSimple>
        <d2p1:AcStockID>String</d2p1:AcStockID>
        <d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
        <d2p1:AcSupGoodsReturnNoteMID>String</d2p1:AcSupGoodsReturnNoteMID>
        <d2p1:ItemDiscountAmount>0</d2p1:ItemDiscountAmount>
        <d2p1:ItemGrossTotal>0</d2p1:ItemGrossTotal>
        <d2p1:ItemNo>0</d2p1:ItemNo>
        <d2p1:ItemQuantity>0</d2p1:ItemQuantity>
        <d2p1:ItemRemark1>String</d2p1:ItemRemark1>
        <d2p1:ItemTotalPrice>0</d2p1:ItemTotalPrice>
        <d2p1:ItemUnitPrice>0</d2p1:ItemUnitPrice>
      </d2p1:AcSupGoodsReturnNoteDSimple>
    </d2p1:DocumentDetails>
    <d2p1:DocumentHeader>
      <d2p1:AcLocationID>String</d2p1:AcLocationID>
      <d2p1:AcSupGoodsReturnNoteMID>String</d2p1:AcSupGoodsReturnNoteMID>
      <d2p1:AcSupplierID>String</d2p1:AcSupplierID>
      <d2p1:DocumentCentBalance>0</d2p1:DocumentCentBalance>
      <d2p1:DocumentDate>0001-01-01T00:00:00</d2p1:DocumentDate>
      <d2p1:DocumentFinalAmount>0</d2p1:DocumentFinalAmount>
      <d2p1:DocumentNetAmount>0</d2p1:DocumentNetAmount>
      <d2p1:DocumentRemark>String</d2p1:DocumentRemark>
      <d2p1:ExtraRemark1>String</d2p1:ExtraRemark1>
      <d2p1:ExtraRemark2>String</d2p1:ExtraRemark2>
      <d2p1:ExtraRemark3>String</d2p1:ExtraRemark3>
      <d2p1:ExtraRemark4>String</d2p1:ExtraRemark4>
      <d2p1:IsConsignmentINStockOnly>String</d2p1:IsConsignmentINStockOnly>
      <d2p1:RefDocumentNo>String</d2p1:RefDocumentNo>
      <d2p1:SupplierDONumber>String</d2p1:SupplierDONumber>
    </d2p1:DocumentHeader>
  </SupplierGoodsReturnNote>
</CreateSupplierGoodsReturnNoteSimpleResponse>

SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

CreateSupplierGoodsReturnNoteSimple

Supplier Goods Return Note API

HTTP + XML