DownloadThis GET API can be used to retrieve Bill to Location details in GEP SMART to post them into ERP.
URL Format: https://<Instance>/SmartInterfaceAPI/api/BillToLocation/Number
https://<Instance>.gep.com/SmartInterfaceAPI/api/BillToLocation/Number?BillToLocationNumber=BillToLocNum_12
{
"data": [
{
"billToLocationName": "String",
"billToLocationNumber": "String",
"addressLine1": "String",
"addressLine2": "String",
"addressLine3": "String",
"city": "String",
"stateCode": "String",
"zip": "String",
"countryCode": "String",
"isDeleted": false,
"isDefault": true,
"stateOther": "String",
"lobEntityCode": " String",
"lstOrgEntity": [
{
"entityCode": "String",
"isDefault": true,
"entityType": " String",
"lobEntityCode": " String"
}
]
}
],
"statusCode": " String ",
"errorDetails": [
{
"key": "string",
"errors": [
{
"errorCode": "string",
"errorDescription": "string"
}
]
}
],
"successDetails": [
{
"key": "String"
}
]
}
Success Scenario - Request
https://<Instance>.gep.com/SmartInterfaceAPI/api/BillToLocation/Number?BillToLocationNumber= BillToLocNum_12
Success Scenario - Response
{
"data": {
"billToLocationName": "billToLocationName44",
"billToLocationNumber": "BillToLocNum_12",
"addressLine1": "REMARKABLES PARK",
"addressLine2": "",
"addressLine3": "",
"city": "QUEENSTOWN",
"stateCode": "AK",
"zip": "00443",
"countryCode": "US",
"isDeleted": false,
"isDefault": false,
"stateOther": "",
"lobEntityCode": null,
"lstOrgEntity": null
},
"statusCode": "200",
"errorDetails": [],
"successDetails": [
{
"key": "BillToLocNum_12"
}
]
}
Error Scenario 1 - Request
https://<Instance>.gep.com/SmartInterfaceAPI/api/BillToLocation/Number?BillToLocationNumber=
Error Scenario 1 – Response
{
"statuscode": 404,
"message": "Resource not found"
}
Error Scenario 2 - Request
https://<Instance>.gep.com/SmartInterfaceAPI/api/BillToLocation/Number?BillToLocationNumber=testBill
Error Scenario 2 - Response
{
"data": null,
"statusCode": "400",
"errorDetails": [
{
"key": "3333",
"errors": [
{
"errorCode": "DataValidation",
"errorDescription": "Invalid BillToLocation Number"
}
]
}
],
"successDetails": []
}
|
Get BillToLocation By Number |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1 |
List of BillToLocation object |
||||
|
2 |
StatusCode |
String |
|||
|
3 |
List of ErrorModel object |
||||
|
4 |
List of SuccessModel object |
||||
|
Data |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.1 |
BillToLocationName |
String(100) |
Name of this Bill To Location |
||
|
1.2 |
BillToLocationNumber |
String(100) |
Number of this Bill To Location |
||
|
1.3 |
AddressLine1 |
String(500) |
Address line 1 of the entity |
||
|
1.4 |
AddressLine2 |
String(100) |
Address line 2 of the entity |
||
|
1.5 |
AddressLine3 |
String(100) |
Address line 3 of the entity |
||
|
1.8 |
City |
String(50) |
City of the entity |
||
|
1.7 |
StateCode |
String(10) |
State code of the entity |
||
|
1.8 |
Zip |
String(10) |
Zip code of the entity |
||
|
1.9 |
CountryCode |
String(2) |
Country code of the entity |
||
|
1.10 |
IsDeleted |
Boolean |
A flag used to denote if the Bill To Location is the default Bill To Location or not |
||
|
1.11 |
IsDefault |
Boolean |
A flag used to denote if the Ship To Location is soft deleted or not |
||
|
1.12 |
StateOther |
String |
State which is different from the list of states provided |
||
|
1.13 |
LobEntityCode |
String(100) |
Line of Business Code for BillToLocation |
||
|
1.14 |
List of OrgEntity object |
Check data type OrgEntity for details |
|||
|
LstOrgEntity |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
1.14.1 |
EntityCode |
String(100) |
Entity Code of the entity |
||
|
1.14.2 |
IsDefault |
Boolean |
A flag used to denote if entity is the default or not |
||
|
1.14.3 |
EntityType |
String(100) |
Entity Type of the entity |
||
|
1.14.4 |
LobEntityCode |
String(100) |
Lob Entity Code of the entity |
||
|
ErrorDetails |
|||||
|
S.No. |
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
3.1 |
Key |
String |
|||
|
3.2 |
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 |
|||