POST v1/gl-accounts/search

Gets GL Accounts based on filters

Request Information

URI Parameters

None.

Body Parameters

GLAccountSearchParameters
NameDescriptionTypeAdditional information
AccountTypeId

integer

None.

AccountName

string

None.

Active

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "accountTypeId": 1,
  "accountName": "sample string 1",
  "active": true
}

application/xml, text/xml

Sample:
<GLAccountSearchParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <AccountName>sample string 1</AccountName>
  <AccountTypeId>1</AccountTypeId>
  <Active>true</Active>
</GLAccountSearchParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResultOfGLAccountSearchResult
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Data

Collection of GLAccountSearchResult

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "accountName": "sample string 2",
      "accountExtendedName": "sample string 3",
      "accountType": {
        "id": 1,
        "name": "sample string 2"
      },
      "parent": {
        "extendedName": "sample string 1",
        "id": 2,
        "name": "sample string 3"
      },
      "accountNumber": "sample string 4",
      "doNotAllowPosting": true,
      "isReconcilable": true,
      "active": true
    },
    {
      "id": 1,
      "accountName": "sample string 2",
      "accountExtendedName": "sample string 3",
      "accountType": {
        "id": 1,
        "name": "sample string 2"
      },
      "parent": {
        "extendedName": "sample string 1",
        "id": 2,
        "name": "sample string 3"
      },
      "accountNumber": "sample string 4",
      "doNotAllowPosting": true,
      "isReconcilable": true,
      "active": true
    }
  ]
}

application/xml, text/xml

Sample:
<SearchResultOfGLAccountSearchResult9X4wrT_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:GLAccountSearchResult>
      <d2p1:AccountExtendedName>sample string 3</d2p1:AccountExtendedName>
      <d2p1:AccountName>sample string 2</d2p1:AccountName>
      <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
      <d2p1:AccountType 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:AccountType>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DoNotAllowPosting>true</d2p1:DoNotAllowPosting>
      <d2p1:IsReconcilable>true</d2p1:IsReconcilable>
      <d2p1:Parent xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>2</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 3</d4p1:_x003C_Name_x003E_k__BackingField>
        <d4p1:ExtendedName>sample string 1</d4p1:ExtendedName>
      </d2p1:Parent>
      <d2p1:id>1</d2p1:id>
    </d2p1:GLAccountSearchResult>
    <d2p1:GLAccountSearchResult>
      <d2p1:AccountExtendedName>sample string 3</d2p1:AccountExtendedName>
      <d2p1:AccountName>sample string 2</d2p1:AccountName>
      <d2p1:AccountNumber>sample string 4</d2p1:AccountNumber>
      <d2p1:AccountType 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:AccountType>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:DoNotAllowPosting>true</d2p1:DoNotAllowPosting>
      <d2p1:IsReconcilable>true</d2p1:IsReconcilable>
      <d2p1:Parent xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>2</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 3</d4p1:_x003C_Name_x003E_k__BackingField>
        <d4p1:ExtendedName>sample string 1</d4p1:ExtendedName>
      </d2p1:Parent>
      <d2p1:id>1</d2p1:id>
    </d2p1:GLAccountSearchResult>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfGLAccountSearchResult9X4wrT_Pq>