GetOrgEntityByEntityCode (GET)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

This GET API can be used to retrieve organization details in GEP SMART to post them into ERP.

 

URL Format: https://<Instance>/SmartInterfaceAPI/api/Organization/EntityCode

Request

EntityCode and EntityType are mandatory attribute for this API call.

 

https://<Instance>/SmartInterfaceAPI/api/Organization/EntityCode?EntityCode=KEU28941-1&EntityType=Cost Center

 

Response 
{
   "data": [
      {
         "entityType": "string",
         "name": "string",
         "code": "string",
         "lobEntityCode": "string",
         "lobEntityType": "string",
         "parentEntityType": "string",
         "parentEntityCode": "string",
         "isActive": true,
         "parentEntityCodes": [
            "string"
         ],
         "isUpdateParentEntities": true,
         "isMapToAllChildEntity": true,
         "isMapToAllParentEntity": true,
         "address": {
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "city": "string",
            "stateCode": "string",
            "stateOther": "string",
            "countryCode": "string",
            "zipCode": "string",
            "faxNo": "string",
            "phoneNo": "string",
            "phoneOther": "string",
            "phoneExtension": "string",
            "phoneOtherExtension": "string",
            "county": "string",
            "poBoxNumber": "string"
         },
         "parentEntityCodeDelta": [
            {
               "entityCode": "string",
               "isActive": true
            }
         ]
      }
   ],
   "statusCode": "200",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "string"
      }
   ]
}

 

Examples

Success Scenario - Request

https://<Instance>/SmartInterfaceAPI/api/Organization/EntityCode?EntityCode=KEU28941-1&EntityType=Cost Center

 

Success Scenario - Response

{
   "data": {
      "entityType": "Cost Center",
      "name": "KEU28941-1",
      "code": "KEU28941-1",
      "lobEntityCode": "KEU-SAP",
      "lobEntityType": "Source System",
      "parentEntityType": "Company Code",
      "parentEntityCode": "PIES",
      "isActive": true,
      "parentEntityCodes": [
         "PIES"
      ],
      "isUpdateParentEntities": false,
      "isMapToAllChildEntity": false,
      "isMapToAllParentEntity": false
   },
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "Test1forKEU28941-1"
      }
   ]
}

 

Data Elements
 

Get Org Entities by Entity Code

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1

Data

  

List of OrganizationEntity object

    

2

StatusCode

  

String

    

3

ErrorDetails

  

List of ErrorModel object

    

4

SuccessDetails

  

List of SuccessModel object

    
 

Data

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.1

EntityType

  

String

Entity Type of the entity

  

1.2

Name

  

String

Name of the entity

  

1.3

Code

  

String

Code of the entity

  

1.4

LOBEntityCode

  

String

Line of Business Entity Code of the entity

  

1.5

LOBEntityType

  

String

Line of Business Entity Type of the entity

  

1.6

ParentEntityType

  

String

Parent Entity Type of the entity

  

1.7

ParentEntityCode

  

String

Parent Entity Code of the entity

  

1.8

IsActive

  

Boolean

Status of the entity if active or not

  

1.9

ParentEntityCodes

  

List of String

Parent Entity Codes of the entity

  

1.10

IsUpdateParentEntities

  

Boolean

Status of the updates of parent entity if active or not

  

1.11

IsMapToAllChildEntity

  

Boolean

    

1.12

IsMapToAllParentEntity

  

Boolean

Status of the parent entity if active or not

  

1.13

Address

  

Address object

Check Data Type Address for Details

  

1.14

ParentEntityCodeDelta

  

List of ParentEntityCodeDelta object

Check Data Type ParentEntityCodeDelta for Details

  
 

Address

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.13.1

County

  

String

County of the address

  

1.13.2

PhoneOtherExtension

  

String

Phone 2’s extension of the entity

  

1.13.3

PhoneExtension

  

String

Phone extension of the entity

  

1.13.4

PhoneOther

  

String

Phone 2 of the entity

  

1.13.5

PhoneNo

  

String

Phone number of the entity

  

1.13.6

FaxNo

  

String

Fax number of the entity

  

1.13.7

ZipCode

  

String

Zip code of the entity

  

1.13.8

CountryCode

  

String

Country code of the entity

  

1.13.9

StateOther

  

String

State name (in case of others) of the entity

  

1.13.10

StateCode

  

String

State code of the entity

  

1.13.11

City

  

String

City of the entity

  

1.13.12

AddressLine3

  

String

Address line 3 of the entity

  

1.13.13

AddressLine2

  

String

Address line 2 of the entity

  

1.13.14

AddressLine1

  

String

Address line 1 of the entity

  

1.13.15

POBoxNumber

  

String

    
 

ParentEntityCodeDelta

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1.14.1

EntityCode

  

String

Code of the entity

  

1.14.2

IsActive

  

Boolean

Status of the entity if active or not

  
 

ErrorDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.1

Key

  

String

    

3.2

Errors

  

List of Error object

    
 

Errors

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

3.2.1

ErrorCode

  

String

    

3.2.2

ErrorDescription

  

String

    
 

SuccessDetails

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

4.1

Key

  

String