POST v1/invoices/search

Search for invoice using the search filters passed in request body

Request Information

URI Parameters

None.

Body Parameters

All available search parameters

InvoiceSearchParameters
NameDescriptionTypeAdditional information
TxnNumber

string

None.

CustomerId

integer

None.

DateCreatedFrom

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

date

None.

DateCreatedTo

The date and time (in company time zone) when the invoice was last updated.

date

None.

DueDateFrom

date

None.

DueDateTo

date

None.

LastUpdatedDateFrom

The date and time (in company time zone) when the invoice was last updated.

date

None.

LastUpdatedDateTo

The date and time (in company time zone) when the invoice was last updated.

date

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:
{
  "txnNumber": "sample string 1",
  "customerId": 1,
  "dateCreatedFrom": "2022-07-06T12:27:48.0213133-04:00",
  "dateCreatedTo": "2022-07-06T12:27:48.0213133-04:00",
  "dueDateFrom": "2022-07-06T12:27:48.0213133-04:00",
  "dueDateTo": "2022-07-06T12:27:48.0213133-04:00",
  "lastUpdatedDateFrom": "2022-07-06T12:27:48.0213133-04:00",
  "lastUpdatedDateTo": "2022-07-06T12:27:48.0213133-04:00",
  "withOpenBalanceOnly": true,
  "pageIndex": 2,
  "pageSize": 3,
  "sortExpression": "sample string 4",
  "sortOrder": 5
}

application/xml, text/xml

Sample:
<InvoiceSearchParameters 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>
  <DateCreatedFrom>2022-07-06T12:27:48.0213133-04:00</DateCreatedFrom>
  <DateCreatedTo>2022-07-06T12:27:48.0213133-04:00</DateCreatedTo>
  <DueDateFrom>2022-07-06T12:27:48.0213133-04:00</DueDateFrom>
  <DueDateTo>2022-07-06T12:27:48.0213133-04:00</DueDateTo>
  <LastUpdatedDateFrom>2022-07-06T12:27:48.0213133-04:00</LastUpdatedDateFrom>
  <LastUpdatedDateTo>2022-07-06T12:27:48.0213133-04:00</LastUpdatedDateTo>
  <TxnNumber>sample string 1</TxnNumber>
  <WithOpenBalanceOnly>true</WithOpenBalanceOnly>
</InvoiceSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfInvoiceSearchResult
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Data

Collection of InvoiceSearchResult

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "txnNumber": "sample string 2",
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "dueDate": "2022-07-06T12:27:48.0213133-04:00",
      "invoiceTotal": 1.0,
      "openBalance": 1.0,
      "memo": "sample string 3",
      "dateCreated": "2022-07-06T12:27:48.0213133-04:00",
      "lastUpdatedDate": "2022-07-06T12:27:48.0213133-04:00",
      "currency": {
        "currencyISOCode": "sample string 1",
        "exchangeRate": 2.0
      }
    },
    {
      "id": 1,
      "txnNumber": "sample string 2",
      "customer": {
        "id": 1,
        "name": "sample string 2"
      },
      "dueDate": "2022-07-06T12:27:48.0213133-04:00",
      "invoiceTotal": 1.0,
      "openBalance": 1.0,
      "memo": "sample string 3",
      "dateCreated": "2022-07-06T12:27:48.0213133-04:00",
      "lastUpdatedDate": "2022-07-06T12:27:48.0213133-04:00",
      "currency": {
        "currencyISOCode": "sample string 1",
        "exchangeRate": 2.0
      }
    }
  ]
}

application/xml, text/xml

Sample:
<SearchResultOfInvoiceSearchResult9X4wrT_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:InvoiceSearchResult>
      <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/BBM.BLL.Core">
        <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>2022-07-06T12:27:48.0213133-04:00</d2p1:DateCreated>
      <d2p1:DueDate>2022-07-06T12:27:48.0213133-04:00</d2p1:DueDate>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InvoiceTotal>1</d2p1:InvoiceTotal>
      <d2p1:LastUpdatedDate>2022-07-06T12:27:48.0213133-04:00</d2p1:LastUpdatedDate>
      <d2p1:Memo>sample string 3</d2p1:Memo>
      <d2p1:OpenBalance>1</d2p1:OpenBalance>
      <d2p1:TxnNumber>sample string 2</d2p1:TxnNumber>
    </d2p1:InvoiceSearchResult>
    <d2p1:InvoiceSearchResult>
      <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/BBM.BLL.Core">
        <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>2022-07-06T12:27:48.0213133-04:00</d2p1:DateCreated>
      <d2p1:DueDate>2022-07-06T12:27:48.0213133-04:00</d2p1:DueDate>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:InvoiceTotal>1</d2p1:InvoiceTotal>
      <d2p1:LastUpdatedDate>2022-07-06T12:27:48.0213133-04:00</d2p1:LastUpdatedDate>
      <d2p1:Memo>sample string 3</d2p1:Memo>
      <d2p1:OpenBalance>1</d2p1:OpenBalance>
      <d2p1:TxnNumber>sample string 2</d2p1:TxnNumber>
    </d2p1:InvoiceSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfInvoiceSearchResult9X4wrT_Pq>