SmartAcc DynaMod Web API v2024.4 Build 0000

CustomerReceiptsSimple

Customer Module - Transaction

Customer Receipt API

**Requires Authentication**
Required permission:	CustomerReceipt-Transaction.GET

The following routes are available for this service:
GET	/CustomerReceipts/simple
GET	/CustomerReceipts/simple/page/{Page}	Get records by given a page number	Each page consists of 20 records
GET	/CustomerReceipts/simple/Receipt/{AcCusReceiptMID}	Get a record by given a Document Number	Header and Detail record would be return if found.

**CustomerReceiptsSimple** Parameters:
Name	Parameter	Data Type	Required	Description
Page	path	int?	No
AcCusReceiptMID	path	string	No

**CustomerReceiptsSimpleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Receipts	form	List<CustomerReceiptSimple>	No
ResponseStatus	form	ResponseStatus	No

**CustomerReceiptSimple** Parameters:
Name	Parameter	Data Type	Required	Description
DocumentHeader	form	DocumentHeader	Yes	Customer Receipt Header - Primary Key: AcCusReceiptMID
DocumentDetails	form	DocumentDetails	Yes	Customer Receipt Knock-Off Details - Primary Key: AcCusReceiptMID, ItemNo, MatchType, MatchDocumentNo. Note: You may get the outstanding list from CustomerOutstandingDocumentListing service.
DocumentPaymentDetails	form	DocumentKnockOffDetails	Yes	Customer Receipt Payment Details - Primary Key: AcCusReceiptMID, ItemNo, AcBillPaymentMethodID.

**AcCusReceiptMSimple** Parameters:
Name	Parameter	Data Type	Required	Description
AcCusReceiptMID	form	NVARCHAR(20)	Yes	Receipt Number
AcCustomerID	form	NVARCHAR(20)	Yes	Customer ID
AcLocationID	form	NVARCHAR(20)	Yes	Location ID
DocumentDate	form	DATE	Yes	Receipt Date
RefDocumentNo	form	NVARCHAR(50)	No	Reference Number
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
AcCusReceiptTypeID	form	NVARCHAR(20)	Yes	Receipt Type ID (CUSTOMER RECEIPT)
Payee	form	NVARCHAR(100)	Yes	Payee Name. Default to Customer Name
AcSalesmanID	form	NVARCHAR(20)	Yes	Salesman ID
DocumentItemCurrencyAmount	form	NUMERIC(18,2)	Yes	Total Item Amount.
DocumentItemCurrencyAppliedAmount	form	NUMERIC(18,2)	Yes	Total Applied Amount. Total knock-off amount that applied to outstanding invoices.
DocumentItemCurrencyBalanceAmount	form	NUMERIC(18,2)	Yes	Total Balance Amount. (DocumentPaymentCurrencyAmount - DocumentItemCurrencyAppliedAmount).
DocumentPaymentCurrencyAmount	form	NUMERIC(18,2)	Yes	Total Payment Amount.
DocumentUnappliedCurrencyAmount	form	NUMERIC(18,2)	Yes	Total Unapplied Amount. It would be Advanced Amount. Balance amount after knock-off amount to outstanding invoice amount.

**AcCusReceiptDSimple** Parameters:
Name	Parameter	Data Type	Required	Description
AcCusReceiptDID	form	NVARCHAR(40)	Yes	Record ID. Recommend use GUID
AcCusReceiptMID	form	NVARCHAR(20)	Yes	Receipt Number
ItemNo	form	INT	Yes	Item Number
MatchType	form	NVARCHAR(20)	Yes	Match Document Type. Source of Document: Eg: Customer Invoice
MatchDocumentNo	form	NVARCHAR(20)	Yes	Match Document Number. Document Number to be knock-off. Eg: Customer Invoice Number
ItemRemark1	form	NVARCHAR(MAX)	Yes	Item Remark 1
ItemCurrencyAmount	form	NUMERIC(18,2)	Yes	Item Currency Amount. Current outstanding amount.
ItemCurrencyAppliedAmount	form	NUMERIC(18,2)	Yes	Item Currency Applied Amount. Amount used to knock-off the oustanding amount. Applied amount should not greater than outstanding amount.
ItemCurrencyBalanceAmount	form	NUMERIC(18,2)	Yes	Item Currency Balance Amount. Balance amount after knock-off the outstanding amount. (ItemCurrencyBalanceAmount = ItemCurrencyAmount - ItemCurrencyAppliedAmount). Should not have negative balance.

**AcCusReceiptPaySimple** Parameters:
Name	Parameter	Data Type	Required	Description
AcCusReceiptMID	form	NVARCHAR(20)	Yes	Receipt Number
ItemNo	form	INT	Yes	Item Number
AcBillPaymentMethodID	form	NVARCHAR(20)	Yes	Bill Payment Method ID
ItemReferenceNumber	form	NVARCHAR(100)	No	Reference Number
ItemRemark1	form	NVARCHAR(MAX)	Yes	Item Remark 1
ItemCurrencyPaymentAmount	form	NUMERIC(18,2)	Yes	Item Currency Payment Amount

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.

GET /CustomerReceipts/simple HTTP/1.1 
Host: snr2u.com 
Accept: application/xml

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

<CustomerReceiptsSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <Receipts xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:CustomerReceiptSimple>
      <d2p1:DocumentDetails>
        <d2p1:AcCusReceiptDSimple>
          <d2p1:AcCusReceiptDID>String</d2p1:AcCusReceiptDID>
          <d2p1:AcCusReceiptMID>String</d2p1:AcCusReceiptMID>
          <d2p1:ItemCurrencyAmount>0</d2p1:ItemCurrencyAmount>
          <d2p1:ItemCurrencyAppliedAmount>0</d2p1:ItemCurrencyAppliedAmount>
          <d2p1:ItemCurrencyBalanceAmount>0</d2p1:ItemCurrencyBalanceAmount>
          <d2p1:ItemNo>0</d2p1:ItemNo>
          <d2p1:ItemRemark1>String</d2p1:ItemRemark1>
          <d2p1:MatchDocumentNo>String</d2p1:MatchDocumentNo>
          <d2p1:MatchType>String</d2p1:MatchType>
        </d2p1:AcCusReceiptDSimple>
      </d2p1:DocumentDetails>
      <d2p1:DocumentHeader>
        <d2p1:AcCusReceiptMID>String</d2p1:AcCusReceiptMID>
        <d2p1:AcCusReceiptTypeID>String</d2p1:AcCusReceiptTypeID>
        <d2p1:AcCustomerID>String</d2p1:AcCustomerID>
        <d2p1:AcLocationID>String</d2p1:AcLocationID>
        <d2p1:AcSalesmanID>String</d2p1:AcSalesmanID>
        <d2p1:DocumentDate>0001-01-01T00:00:00</d2p1:DocumentDate>
        <d2p1:DocumentItemCurrencyAmount>0</d2p1:DocumentItemCurrencyAmount>
        <d2p1:DocumentItemCurrencyAppliedAmount>0</d2p1:DocumentItemCurrencyAppliedAmount>
        <d2p1:DocumentItemCurrencyBalanceAmount>0</d2p1:DocumentItemCurrencyBalanceAmount>
        <d2p1:DocumentPaymentCurrencyAmount>0</d2p1:DocumentPaymentCurrencyAmount>
        <d2p1:DocumentRemark>String</d2p1:DocumentRemark>
        <d2p1:DocumentUnappliedCurrencyAmount>0</d2p1:DocumentUnappliedCurrencyAmount>
        <d2p1:ExtraRemark1>String</d2p1:ExtraRemark1>
        <d2p1:ExtraRemark2>String</d2p1:ExtraRemark2>
        <d2p1:ExtraRemark3>String</d2p1:ExtraRemark3>
        <d2p1:ExtraRemark4>String</d2p1:ExtraRemark4>
        <d2p1:Payee>String</d2p1:Payee>
        <d2p1:RefDocumentNo>String</d2p1:RefDocumentNo>
      </d2p1:DocumentHeader>
      <d2p1:DocumentPaymentDetails>
        <d2p1:AcCusReceiptPaySimple>
          <d2p1:AcBillPaymentMethodID>String</d2p1:AcBillPaymentMethodID>
          <d2p1:AcCusReceiptMID>String</d2p1:AcCusReceiptMID>
          <d2p1:ItemCurrencyPaymentAmount>0</d2p1:ItemCurrencyPaymentAmount>
          <d2p1:ItemNo>0</d2p1:ItemNo>
          <d2p1:ItemReferenceNumber>String</d2p1:ItemReferenceNumber>
          <d2p1:ItemRemark1>String</d2p1:ItemRemark1>
        </d2p1:AcCusReceiptPaySimple>
      </d2p1:DocumentPaymentDetails>
    </d2p1:CustomerReceiptSimple>
  </Receipts>
  <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>
</CustomerReceiptsSimpleResponse>

SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

CustomerReceiptsSimple

Customer Receipt API

HTTP + XML