POST v1/payments/search
Gets list of payments using the search filters.
Request Information
URI Parameters
None.
Body Parameters
PaymentSearchParametersName | Description | Type | Additional information |
---|---|---|---|
ReferenceNumber | string |
None. |
|
CustomerId | integer |
None. |
|
StatusChangedTo | integer |
None. |
|
StatusChangedDateRange |
The date and time (in company time zone) when the payment status was changed. |
DateRange |
None. |
DateCreatedRange |
The date and time (in company time zone) when the payment was created. |
DateRange |
None. |
LastUpdatedDateRange |
The date and time (in company time zone) when the payment was last updated. |
DateRange |
None. |
WithOpenBalanceOnly | boolean |
None. |
|
PageIndex |
zero-based page number |
integer |
None. |
PageSize |
Default value is 100 |
integer |
Range: inclusive between 1 and 1000 |
SortExpression |
Specify the field name to sort the result set by. It can be one of the fields returned by the search. |
string |
None. |
SortOrder |
Specify Sort Order. Ascending=1, Descending=2. Default value is 1 (Ascending) |
integer |
Range: inclusive between 1 and 2 |
Request Formats
application/json, text/json
Sample:
{ "referenceNumber": "sample string 1", "customerId": 1, "statusChangedTo": 1, "statusChangedDateRange": null, "dateCreatedRange": null, "lastUpdatedDateRange": null, "withOpenBalanceOnly": true, "pageIndex": 2, "pageSize": 3, "sortExpression": "sample string 4", "sortOrder": 5 }
application/xml, text/xml
Sample:
<PaymentSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting"> <PageIndex xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">2</PageIndex> <PageSize xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">3</PageSize> <SortExpression xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">sample string 4</SortExpression> <SortOrder xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">5</SortOrder> <CustomerId>1</CustomerId> <DateCreatedRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" /> <LastUpdatedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" /> <ReferenceNumber>sample string 1</ReferenceNumber> <StatusChangedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" /> <StatusChangedTo>1</StatusChangedTo> <WithOpenBalanceOnly>true</WithOpenBalanceOnly> </PaymentSearchParameters>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SearchResultOfPaymentSearchResultName | Description | Type | Additional information |
---|---|---|---|
TotalCount | integer |
None. |
|
Data | Collection of PaymentSearchResult |
None. |
Response Formats
application/json, text/json
Sample:
{ "totalCount": 1, "data": [ { "id": 1, "referenceNumber": "sample string 2", "paymentDate": "2024-03-29T08:39:17.542067-04:00", "customer": { "id": 1, "name": "sample string 2" }, "status": { "id": 1, "name": "sample string 2" }, "paymentAmount": 4.0, "openBalance": 5.0, "dateCreated": "2024-03-29T08:39:17.542067-04:00", "lastUpdatedDate": "2024-03-29T08:39:17.542067-04:00", "currency": { "currencyISOCode": "sample string 1", "exchangeRate": 2.0 } }, { "id": 1, "referenceNumber": "sample string 2", "paymentDate": "2024-03-29T08:39:17.542067-04:00", "customer": { "id": 1, "name": "sample string 2" }, "status": { "id": 1, "name": "sample string 2" }, "paymentAmount": 4.0, "openBalance": 5.0, "dateCreated": "2024-03-29T08:39:17.542067-04:00", "lastUpdatedDate": "2024-03-29T08:39:17.542067-04:00", "currency": { "currencyISOCode": "sample string 1", "exchangeRate": 2.0 } } ] }
application/xml, text/xml
Sample:
<SearchResultOfPaymentSearchResult9X4wrT_Pq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting"> <d2p1:PaymentSearchResult> <d2p1:Currency xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core"> <d4p1:_x003C_CurrencyISOCode_x003E_k__BackingField>sample string 1</d4p1:_x003C_CurrencyISOCode_x003E_k__BackingField> <d4p1:_x003C_ExchangeRate_x003E_k__BackingField>2</d4p1:_x003C_ExchangeRate_x003E_k__BackingField> </d2p1:Currency> <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField> <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField> </d2p1:Customer> <d2p1:DateCreated>2024-03-29T08:39:17.542067-04:00</d2p1:DateCreated> <d2p1:Id>1</d2p1:Id> <d2p1:LastUpdatedDate>2024-03-29T08:39:17.542067-04:00</d2p1:LastUpdatedDate> <d2p1:OpenBalance>5</d2p1:OpenBalance> <d2p1:PaymentAmount>4</d2p1:PaymentAmount> <d2p1:PaymentDate>2024-03-29T08:39:17.542067-04:00</d2p1:PaymentDate> <d2p1:ReferenceNumber>sample string 2</d2p1:ReferenceNumber> <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField> <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField> </d2p1:Status> </d2p1:PaymentSearchResult> <d2p1:PaymentSearchResult> <d2p1:Currency xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core"> <d4p1:_x003C_CurrencyISOCode_x003E_k__BackingField>sample string 1</d4p1:_x003C_CurrencyISOCode_x003E_k__BackingField> <d4p1:_x003C_ExchangeRate_x003E_k__BackingField>2</d4p1:_x003C_ExchangeRate_x003E_k__BackingField> </d2p1:Currency> <d2p1:Customer xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField> <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField> </d2p1:Customer> <d2p1:DateCreated>2024-03-29T08:39:17.542067-04:00</d2p1:DateCreated> <d2p1:Id>1</d2p1:Id> <d2p1:LastUpdatedDate>2024-03-29T08:39:17.542067-04:00</d2p1:LastUpdatedDate> <d2p1:OpenBalance>5</d2p1:OpenBalance> <d2p1:PaymentAmount>4</d2p1:PaymentAmount> <d2p1:PaymentDate>2024-03-29T08:39:17.542067-04:00</d2p1:PaymentDate> <d2p1:ReferenceNumber>sample string 2</d2p1:ReferenceNumber> <d2p1:Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models"> <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField> <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField> </d2p1:Status> </d2p1:PaymentSearchResult> </Data> <TotalCount>1</TotalCount> </SearchResultOfPaymentSearchResult9X4wrT_Pq>