POST v1/bill-credits/search

Gets list of bill credits using the search filters passed in the request body.

Request Information

URI Parameters

None.

Body Parameters

BillCreditSearchParameters
NameDescriptionTypeAdditional information
Number

string

None.
VendorId

integer

None.
StatusChangedTo

integer

None.
StatusChangedDateRange

The date and time (in company time zone) when the bill credit status was changed.

 DateRange

None.
DateCreatedRange

The date and time (in company time zone) when the bill credit was created.

 DateRange

None.
LastUpdatedDateRange

The date and time (in company time zone) when the bill credit 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: 
{
  "number": "sample string 1",
  "vendorId": 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: 
<BillCreditSearchParameters 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>
  <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" />
  <Number>sample string 1</Number>
  <StatusChangedDateRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models" i:nil="true" />
  <StatusChangedTo>1</StatusChangedTo>
  <VendorId>1</VendorId>
  <WithOpenBalanceOnly>true</WithOpenBalanceOnly>
</BillCreditSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfBillCreditSearchResult
NameDescriptionTypeAdditional information
TotalCount

integer

None.
Data

Collection of BillCreditSearchResult

None.

Response Formats

application/json, text/json

Sample: 
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "number": "sample string 2",
      "dueDate": "2024-04-25T11:17:25.6258725-04:00",
      "vendor": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "memo": "sample string 3",
      "totalAmount": 4.0,
      "openBalance": 5.0,
      "dateCreated": "2024-04-25T11:17:25.6258725-04:00",
      "lastUpdatedDate": "2024-04-25T11:17:25.6258725-04:00",
      "currency": {
        "currencyISOCode": "sample string 1",
        "exchangeRate": 2.0
      }
    },
    {
      "id": 1,
      "number": "sample string 2",
      "dueDate": "2024-04-25T11:17:25.6258725-04:00",
      "vendor": {
        "id": 1,
        "name": "sample string 2"
      },
      "status": {
        "id": 1,
        "name": "sample string 2"
      },
      "memo": "sample string 3",
      "totalAmount": 4.0,
      "openBalance": 5.0,
      "dateCreated": "2024-04-25T11:17:25.6258725-04:00",
      "lastUpdatedDate": "2024-04-25T11:17:25.6258725-04:00",
      "currency": {
        "currencyISOCode": "sample string 1",
        "exchangeRate": 2.0
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<SearchResultOfBillCreditSearchResult9X4wrT_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:BillCreditSearchResult>
      <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:DateCreated>2024-04-25T11:17:25.6258725-04:00</d2p1:DateCreated>
      <d2p1:DueDate>2024-04-25T11:17:25.6258725-04:00</d2p1:DueDate>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2024-04-25T11:17:25.6258725-04:00</d2p1:LastUpdatedDate>
      <d2p1:Memo>sample string 3</d2p1:Memo>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:OpenBalance>5</d2p1:OpenBalance>
      <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:TotalAmount>4</d2p1:TotalAmount>
      <d2p1:Vendor 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:Vendor>
    </d2p1:BillCreditSearchResult>
    <d2p1:BillCreditSearchResult>
      <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:DateCreated>2024-04-25T11:17:25.6258725-04:00</d2p1:DateCreated>
      <d2p1:DueDate>2024-04-25T11:17:25.6258725-04:00</d2p1:DueDate>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LastUpdatedDate>2024-04-25T11:17:25.6258725-04:00</d2p1:LastUpdatedDate>
      <d2p1:Memo>sample string 3</d2p1:Memo>
      <d2p1:Number>sample string 2</d2p1:Number>
      <d2p1:OpenBalance>5</d2p1:OpenBalance>
      <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:TotalAmount>4</d2p1:TotalAmount>
      <d2p1:Vendor 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:Vendor>
    </d2p1:BillCreditSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfBillCreditSearchResult9X4wrT_Pq>