SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

CustomerDebitNotesSimple

Customer Module - Transaction

Customer Debit Note API

Requires Authentication
Required permission:CustomerDebitNote-Transaction.GET
The following routes are available for this service:
GET/CustomerDebitNotes/simple
GET/CustomerDebitNotes/simple/page/{Page}Get records by given a page numberEach page consists of 20 records
GET/CustomerDebitNotes/simple/DebitNote/{AcCusDebitNoteMID}Get a record by given a Document NumberHeader and Detail record would be return if found.
GET/CustomerDebitNotes/simple/EditDate/{fromEditDate}/{toEditDate}Get records by given Edit Date rangeDate format yyyy-MM-dd
CustomerDebitNotesSimple Parameters:
NameParameterData TypeRequiredDescription
Pagepathint?No
AcCusDebitNoteMIDpathstringNo
fromEditDatepathDateTime?No
toEditDatepathDateTime?No
CustomerDebitNotesSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
DebitNotesformList<CustomerDebitNoteSimple>No
ResponseStatusformResponseStatusNo
CustomerDebitNoteSimple Parameters:
NameParameterData TypeRequiredDescription
DocumentHeaderformAcCusDebitNoteMSimpleNo
DocumentDetailsformList<AcCusDebitNoteDSimple>No
AcCusDebitNoteMSimple Parameters:
NameParameterData TypeRequiredDescription
AcCusDebitNoteMIDformNVARCHAR(20)YesDebit Note Number
AcCustomerIDformNVARCHAR(20)YesCustomer ID
AcTermIDformNVARCHAR(40)NoTerm ID
AcSalesmanIDformNVARCHAR(20)NoSalesman ID. Default to customer's salesman if not specified
AcLocationIDformNVARCHAR(20)YesLocation ID
DocumentDateformDATEYesDebit Note Date
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
AcCusInvoiceMIDformNVARCHAR(20)YesCustomer Invoice Number
DocumentReasonformNVARCHAR(100)YesReason
RefDocumentNoformNVARCHAR(100)NoReference Number
DocumentRemarkformNVARCHAR(100)NoDocument Remark
ExtraRemark1formNVARCHAR(100)NoExtra Remark 1
ExtraRemark2formNVARCHAR(100)NoExtra Remark 2
ExtraRemark3formNVARCHAR(100)NoExtra Remark 3
ExtraRemark4formNVARCHAR(100)NoExtra Remark 4
DocumentYourReferenceformNVARCHAR(50)NoYour Reference
ShipToRemarkformNVARCHAR(100)NoShip To: Remark
ShipToShipViaformNVARCHAR(20)NoShip To: Ship Via
ShipToAddress1formNVARCHAR(MAX)NoShip To: Address 1
ShipToAddress2formNVARCHAR(100)NoShip To: Address 2
ShipToAddress3formNVARCHAR(100)NoShip To: Address 3
ShipToAddress4formNVARCHAR(100)NoShip To: Address 4
ShipToPhone1formNVARCHAR(100)NoShip To: Phone 1
ShipToPhone2formNVARCHAR(100)NoShip To: Phone 2
ShipToFaxformNVARCHAR(100)NoShip To: Fax
ShipToContact1formNVARCHAR(100)NoShip To: Contact 1
ShipToContact2formNVARCHAR(100)NoShip To: Contact 2
ShipToAttentionformNVARCHAR(100)NoShip To: Attention
EditDateformDATETIMEYesEdit Date
IsUseAcStockCompanyIDForStockValidationformBooleanNoUse AcStockCompanyID for Stock Validation?. True: Use given AcStockID to search from AcStockCompany.AcStockCompanyID and use result AcStockID, AcStockUOMID; False: Validation will be performed using AcStockID; AcStockUOMID
IsUseTransactionBuyerElementformBooleanNoUse Transaction's Buyer Element?. True: Buyer Elements will stored based on provided value; False: Buyer Elements will stored based on Customer Profile's E-Invoice Elements
AcEInvoiceDocumentFlowIDformNVARCHAR(100)NoE-Invoice Document Flow ID. Open; Ready to Submit; Not Applicable
EInvoiceRegName_BuyerformNVARCHAR(300)NoE-Invoice Registration Name Buyer
EInvoiceRegTIN_BuyerformNVARCHAR(40)NoE-Invoice Registration TIN Buyer
EInvoiceRegNumber_BuyerformNVARCHAR(40)NoE-Invoice Registration Number Buyer
EInvoiceBuyerIsMalaysianformNVARCHAR(1)YesE-Invoice Buyer Is Malaysian. Y/N
EInvoiceBuyerRegTypeformNVARCHAR(20)NoE-Invoice Buyer Registration Type. NRIC/BRN/PASSPORT/ARMY
EInvoiceRegSSTNumber_BuyerformNVARCHAR(40)NoE-Invoice Registration SST Number Buyer
EInvoiceRegEmail_BuyerformNVARCHAR(320)NoE-Invoice Registration Email Buyer
EInvoiceAddressLine0_BuyerformNVARCHAR(150)NoE-Invoice Address Line 0 Buyer
EInvoiceAddressLine1_BuyerformNVARCHAR(150)NoE-Invoice Address Line 1 Buyer
EInvoiceAddressLine2_BuyerformNVARCHAR(150)NoE-Invoice Address Line 2 Buyer
EInvoiceAddressPostalZone_BuyerformNVARCHAR(50)NoE-Invoice Address Postal Zone Buyer
EInvoiceAddressCityName_BuyerformNVARCHAR(50)NoE-Invoice Address City Name Buyer
AcEInvoiceAddressStateID_BuyerformNVARCHAR(20)NoE-Invoice Address State ID Buyer. 00 to 17
AcEInvoiceAddressCountryID_BuyerformNVARCHAR(20)NoE-Invoice Address Country ID Buyer. MYS
EInvoiceRegContactNumber_BuyerformNVARCHAR(20)NoE-Invoice Registration Contact Number Buyer
IsEnableEInvoiceMYSformNVARCHAR(1)NoE-Invoice Is Enabled. (Read-Only)
AcEInvoiceDocumentStatusIDformNVARCHAR(40)NoE-Invoice Document Status ID. (Read-Only). Valid;Invalid;Submitted;Cancelled
IsConsolidatedEInvoiceformNVARCHAR(1)NoE-Invoice Is Marked for Consolidated E-Invoice. Y/N. (Read-Only)
EInvoiceDocumentNumber_ConsolidatedformNVARCHAR(50)NoE-Invoice Consolidated E-Invoice Document Number. (Read-Only)
EInvoiceSubmissionUUIDformNVARCHAR(40)NoE-Invoice Submission UUID. (Read-Only)
EInvoiceValidationUUIDformNVARCHAR(40)NoE-Invoice Validation UUID. (Read-Only)
EInvoiceValidationDateTimeformDATETIMENoE-Invoice Validated Datetime. (Read-Only)
EInvoiceValidationLinkformNVARCHAR(MAX)NoE-Invoice Validation Link. (Read-Only)
AcCustomerNameformNVARCHAR(100)NoCustomer Name (Read-Only)
AcCusDebitNoteDSimple Parameters:
NameParameterData TypeRequiredDescription
AcCusDebitNoteDIDformNVARCHAR(40)YesRecord ID. Recommend use GUID
AcCusDebitNoteMIDformNVARCHAR(20)YesDebit Note Number
ItemNoformINTYesItem Number
AcStockIDformNVARCHAR(40)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
MatchIsActiveformNVARCHAR(1)YesMatch Is Active. (Y/N). Default to N. If Y, please provide MatchType;MatchDocumentNo;MatchItemNo
MatchTypeformNVARCHAR(20)NoMatch Document Type. Valid Value: Sales Order; Delivery Order
MatchDocumentNoformNVARCHAR(20)NoMatch Document Number.
MatchItemNoformINTYesMatch Document Item Number.
AcEInvoiceItemClassificationIDformNVARCHAR(20)NoE-Invoice Item Classification Code (Read-Only)
AcEInvoiceItemTaxTypeIDformNVARCHAR(20)NoE-Invoice Item Tax Type Code (Read-Only)

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 /CustomerDebitNotes/simple HTTP/1.1 
Host: snr2u.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerDebitNotesSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <DebitNotes xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:CustomerDebitNoteSimple>
      <d2p1:DocumentDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerDebitNote">
        <d4p1:AcCusDebitNoteDSimple>
          <d4p1:AcCusDebitNoteDID>String</d4p1:AcCusDebitNoteDID>
          <d4p1:AcCusDebitNoteMID>String</d4p1:AcCusDebitNoteMID>
          <d4p1:AcEInvoiceItemClassificationID>String</d4p1:AcEInvoiceItemClassificationID>
          <d4p1:AcEInvoiceItemTaxTypeID>String</d4p1:AcEInvoiceItemTaxTypeID>
          <d4p1:AcStockID>String</d4p1:AcStockID>
          <d4p1:AcStockUOMID>String</d4p1:AcStockUOMID>
          <d4p1:ItemDiscountAmount>0</d4p1:ItemDiscountAmount>
          <d4p1:ItemGrossTotal>0</d4p1:ItemGrossTotal>
          <d4p1:ItemNo>0</d4p1:ItemNo>
          <d4p1:ItemQuantity>0</d4p1:ItemQuantity>
          <d4p1:ItemRemark1>String</d4p1:ItemRemark1>
          <d4p1:ItemTotalPrice>0</d4p1:ItemTotalPrice>
          <d4p1:ItemUnitPrice>0</d4p1:ItemUnitPrice>
          <d4p1:MatchDocumentNo>String</d4p1:MatchDocumentNo>
          <d4p1:MatchIsActive>String</d4p1:MatchIsActive>
          <d4p1:MatchItemNo>0</d4p1:MatchItemNo>
          <d4p1:MatchType>String</d4p1:MatchType>
        </d4p1:AcCusDebitNoteDSimple>
      </d2p1:DocumentDetails>
      <d2p1:DocumentHeader xmlns:d4p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerDebitNote">
        <d4p1:AcCusDebitNoteMID>String</d4p1:AcCusDebitNoteMID>
        <d4p1:AcCusInvoiceMID>String</d4p1:AcCusInvoiceMID>
        <d4p1:AcCustomerID>String</d4p1:AcCustomerID>
        <d4p1:AcCustomerName>String</d4p1:AcCustomerName>
        <d4p1:AcEInvoiceAddressCountryID_Buyer>String</d4p1:AcEInvoiceAddressCountryID_Buyer>
        <d4p1:AcEInvoiceAddressStateID_Buyer>String</d4p1:AcEInvoiceAddressStateID_Buyer>
        <d4p1:AcEInvoiceDocumentFlowID>String</d4p1:AcEInvoiceDocumentFlowID>
        <d4p1:AcEInvoiceDocumentStatusID>String</d4p1:AcEInvoiceDocumentStatusID>
        <d4p1:AcLocationID>String</d4p1:AcLocationID>
        <d4p1:AcSalesmanID>String</d4p1:AcSalesmanID>
        <d4p1:AcTermID>String</d4p1:AcTermID>
        <d4p1:DocumentCentBalance>0</d4p1:DocumentCentBalance>
        <d4p1:DocumentDate>0001-01-01T00:00:00</d4p1:DocumentDate>
        <d4p1:DocumentFinalAmount>0</d4p1:DocumentFinalAmount>
        <d4p1:DocumentNetAmount>0</d4p1:DocumentNetAmount>
        <d4p1:DocumentReason>String</d4p1:DocumentReason>
        <d4p1:DocumentRemark>String</d4p1:DocumentRemark>
        <d4p1:DocumentYourReference>String</d4p1:DocumentYourReference>
        <d4p1:EInvoiceAddressCityName_Buyer>String</d4p1:EInvoiceAddressCityName_Buyer>
        <d4p1:EInvoiceAddressLine0_Buyer>String</d4p1:EInvoiceAddressLine0_Buyer>
        <d4p1:EInvoiceAddressLine1_Buyer>String</d4p1:EInvoiceAddressLine1_Buyer>
        <d4p1:EInvoiceAddressLine2_Buyer>String</d4p1:EInvoiceAddressLine2_Buyer>
        <d4p1:EInvoiceAddressPostalZone_Buyer>String</d4p1:EInvoiceAddressPostalZone_Buyer>
        <d4p1:EInvoiceBuyerIsMalaysian>String</d4p1:EInvoiceBuyerIsMalaysian>
        <d4p1:EInvoiceBuyerRegType>String</d4p1:EInvoiceBuyerRegType>
        <d4p1:EInvoiceDocumentNumber_Consolidated>String</d4p1:EInvoiceDocumentNumber_Consolidated>
        <d4p1:EInvoiceRegContactNumber_Buyer>String</d4p1:EInvoiceRegContactNumber_Buyer>
        <d4p1:EInvoiceRegEmail_Buyer>String</d4p1:EInvoiceRegEmail_Buyer>
        <d4p1:EInvoiceRegName_Buyer>String</d4p1:EInvoiceRegName_Buyer>
        <d4p1:EInvoiceRegNumber_Buyer>String</d4p1:EInvoiceRegNumber_Buyer>
        <d4p1:EInvoiceRegSSTNumber_Buyer>String</d4p1:EInvoiceRegSSTNumber_Buyer>
        <d4p1:EInvoiceRegTIN_Buyer>String</d4p1:EInvoiceRegTIN_Buyer>
        <d4p1:EInvoiceSubmissionUUID>String</d4p1:EInvoiceSubmissionUUID>
        <d4p1:EInvoiceValidationDateTime>0001-01-01T00:00:00</d4p1:EInvoiceValidationDateTime>
        <d4p1:EInvoiceValidationLink>String</d4p1:EInvoiceValidationLink>
        <d4p1:EInvoiceValidationUUID>String</d4p1:EInvoiceValidationUUID>
        <d4p1:EditDate>0001-01-01T00:00:00</d4p1:EditDate>
        <d4p1:ExtraRemark1>String</d4p1:ExtraRemark1>
        <d4p1:ExtraRemark2>String</d4p1:ExtraRemark2>
        <d4p1:ExtraRemark3>String</d4p1:ExtraRemark3>
        <d4p1:ExtraRemark4>String</d4p1:ExtraRemark4>
        <d4p1:IsConsolidatedEInvoice>String</d4p1:IsConsolidatedEInvoice>
        <d4p1:IsEnableEInvoiceMYS>String</d4p1:IsEnableEInvoiceMYS>
        <d4p1:IsUseAcStockCompanyIDForStockValidation>false</d4p1:IsUseAcStockCompanyIDForStockValidation>
        <d4p1:IsUseTransactionBuyerElement>false</d4p1:IsUseTransactionBuyerElement>
        <d4p1:RefDocumentNo>String</d4p1:RefDocumentNo>
        <d4p1:ShipToAddress1>String</d4p1:ShipToAddress1>
        <d4p1:ShipToAddress2>String</d4p1:ShipToAddress2>
        <d4p1:ShipToAddress3>String</d4p1:ShipToAddress3>
        <d4p1:ShipToAddress4>String</d4p1:ShipToAddress4>
        <d4p1:ShipToAttention>String</d4p1:ShipToAttention>
        <d4p1:ShipToContact1>String</d4p1:ShipToContact1>
        <d4p1:ShipToContact2>String</d4p1:ShipToContact2>
        <d4p1:ShipToFax>String</d4p1:ShipToFax>
        <d4p1:ShipToPhone1>String</d4p1:ShipToPhone1>
        <d4p1:ShipToPhone2>String</d4p1:ShipToPhone2>
        <d4p1:ShipToRemark>String</d4p1:ShipToRemark>
        <d4p1:ShipToShipVia>String</d4p1:ShipToShipVia>
      </d2p1:DocumentHeader>
    </d2p1:CustomerDebitNoteSimple>
  </DebitNotes>
  <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>
</CustomerDebitNotesSimpleResponse>