| Required permission: | CustomerOutstandingDocumentListing-Enquiry.GET |
| GET | /CustomerOutstandingDocumentListing/AcCustomerID/{AcCustomerID} | Get all outstanding documents for the given customer | All outstanding documents would be return if found. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcCustomerID | path | string | Yes | Customer ID. |
| AcCurrencyID | query | string | No | Currency ID. By default system captured the customer's currency's transactions. |
| AcCompanyID | query | string | No | Company ID. System Company ID. Please provide to avoid assumption. If not provided, by default system will capture first record of Company Setup (AcCompany). |
| Page | query | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 99999 Records. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerOutstandingDocumentListing | form | List<pfapi70060GetCustomerOutstandingDocumentListing> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MatchDocumentNo | form | string | No | Match Document Number |
| MatchType | form | string | No | Match Document Type |
| MatchDocumentDate | form | DateTime | No | Match Document Date |
| AcCurrencyID | form | string | No | Match Document Currency ID |
| MatchDocumentCurrencyRate | form | decimal | No | Match Document Currency Rate |
| MatchDocumentAcLocationID | form | string | No | Match Document Location ID |
| AcCustomerID | form | string | No | Match Document Customer ID |
| ItemRemark1 | form | string | No | Match Document Item Remark 1 |
| AcCustomerName | form | string | No | Match Document Customer Name |
| ItemAmount | form | decimal | No | Match Document Item Amount (Outstanding Amount) (Local Currency Amount) |
| ItemBalanceAmount | form | decimal | No | Match Document Item Balance Amount (Applicable Amount) (Local Currency Amount) |
| ItemCurrencyAmount | form | decimal | No | Match Document Item Amount (Outstanding Amount) |
| ItemCurrencyBalanceAmount | form | decimal | No | Match Document Item Balance Amount (Applicable Amount) |
| AcTermID | form | string | No | Term ID |
| TermDays | form | int | No | Term Days |
| IsBadDebtRelief | form | string | No | Is Bad Debt Relief. (GST Related). Y/N. |
| IsOpenBalance | form | string | No | Match Document is an Opening Document. Y/N. |
| TotalItemAppliedAmountOnPDC | form | decimal | No | Total Item Applied Amount on PDC. (Local Currency Amount) |
| TotalItemCurrencyAppliedAmountOnPDC | form | decimal | No | Total Item Applied Amount on PDC. |
| ItemRemark3 | form | string | No | Match Document Item Remark 3 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /CustomerOutstandingDocumentListing/AcCustomerID/{AcCustomerID} HTTP/1.1
Host: snr2u.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerOutstandingDocumentListingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
<CustomerOutstandingDocumentListing xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
<d2p1:pfapi70060GetCustomerOutstandingDocumentListing>
<d2p1:AcCurrencyID>String</d2p1:AcCurrencyID>
<d2p1:AcCustomerID>String</d2p1:AcCustomerID>
<d2p1:AcCustomerName>String</d2p1:AcCustomerName>
<d2p1:AcTermID>String</d2p1:AcTermID>
<d2p1:IsBadDebtRelief>String</d2p1:IsBadDebtRelief>
<d2p1:IsOpenBalance>String</d2p1:IsOpenBalance>
<d2p1:ItemAmount>0</d2p1:ItemAmount>
<d2p1:ItemBalanceAmount>0</d2p1:ItemBalanceAmount>
<d2p1:ItemCurrencyAmount>0</d2p1:ItemCurrencyAmount>
<d2p1:ItemCurrencyBalanceAmount>0</d2p1:ItemCurrencyBalanceAmount>
<d2p1:ItemRemark1>String</d2p1:ItemRemark1>
<d2p1:ItemRemark3>String</d2p1:ItemRemark3>
<d2p1:MatchDocumentAcLocationID>String</d2p1:MatchDocumentAcLocationID>
<d2p1:MatchDocumentCurrencyRate>0</d2p1:MatchDocumentCurrencyRate>
<d2p1:MatchDocumentDate>0001-01-01T00:00:00</d2p1:MatchDocumentDate>
<d2p1:MatchDocumentNo>String</d2p1:MatchDocumentNo>
<d2p1:MatchType>String</d2p1:MatchType>
<d2p1:TermDays>0</d2p1:TermDays>
<d2p1:TotalItemAppliedAmountOnPDC>0</d2p1:TotalItemAppliedAmountOnPDC>
<d2p1:TotalItemCurrencyAppliedAmountOnPDC>0</d2p1:TotalItemCurrencyAppliedAmountOnPDC>
</d2p1:pfapi70060GetCustomerOutstandingDocumentListing>
</CustomerOutstandingDocumentListing>
<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>
<TotalRecords>0</TotalRecords>
<TotalRecordsInPage>0</TotalRecordsInPage>
</CustomerOutstandingDocumentListingResponse>