| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CustomerOutstandingDocumentListing:
[
{
MatchDocumentNo: String,
MatchType: String,
MatchDocumentDate: 0001-01-01,
AcCurrencyID: String,
MatchDocumentCurrencyRate: 0,
MatchDocumentAcLocationID: String,
AcCustomerID: String,
ItemRemark1: String,
AcCustomerName: String,
ItemAmount: 0,
ItemBalanceAmount: 0,
ItemCurrencyAmount: 0,
ItemCurrencyBalanceAmount: 0,
AcTermID: String,
TermDays: 0,
IsBadDebtRelief: String,
IsOpenBalance: String,
TotalItemAppliedAmountOnPDC: 0,
TotalItemCurrencyAppliedAmountOnPDC: 0,
ItemRemark3: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
TotalRecords: 0,
TotalRecordsInPage: 0
}