DownloadThis GET API allows retrieval of Credit Memo details created in GEP SMART to post them into ERP.
URL Format: https://<Instance>/SmartInterfaceAPI/api/CreditMemo/All
https://<Instance>/SmartInterfaceAPI/api/CreditMemo/All
{
"data": [],
"statusCode": "200",
"errorDetails": [],
"successDetails": [
{
"key": "key"
}
]
}
Success Scenario – Request
https://<Instance>/SmartInterfaceAPI/api/CreditMemo/GetCreditMemo
Success Scenario – Response
{
"data": [
{
"basicDetails": {
"documentName": "Credit Memo4 for PO90938174",
"documentNumber": "SCRM-standalone_1",
"documentStatus": "ReadyForPayment",
"documentCreator": null,
"createdOn": "2019-04-18T13:50:03",
"documentLobDetails": [
{
"entityCode": "KNA-SAP",
"entityType": null
}
],
"operationName": "new"
},
"partnerMemoNumber": "CM830173",
"partnerInvoiceNumber": null,
"invoiceReferenceNumber": null,
"partnerName": "SUNBELT RENTALS INC",
"partnerMemoDate": "2019-04-18T13:50:03",
"memoReceivedDate": "2020-04-24T08:57:18.587",
"orderNumber": "PO90938174",
"partnerInvoiceDate": "2020-05-14T15:19:05.839389",
"documentOrigin": "supplier",
"billtoLocation": {
"locationName": "GBS Center",
"locationNumber": "NUUS",
"address": {
"addressline1": "PO Box 8881011",
"addressline2": "",
"addressline3": "",
"city": "Grand Rapids",
"zipCode": "49588",
"stateInfo": {
"stateAbbrevationCode": "MI",
"stateName": null
},
"countryInfo": {
"countryCode": "US",
"countryName": null
},
"phoneNo1": null,
"extenstionNo1": null,
"phoneNo2": null,
"extenstionNo2": null,
"mobileNo": null,
"faxNo": null,
"county": null
},
"deliverTo": null,
"registrationDetails": []
},
"supplierContact": {
"clientContactCode": null,
"emailAddress": "123@gep.com",
"firstName": "Carla",
"lastName": "Wells"
},
"buyerContact": {
"clientContactCode": null,
"emailAddress": "123@gep.com",
"firstName": "Debra",
"lastName": "Underwood"
},
"availableInvoiceTaxAmount": 0,
"billable": false,
"isMultiDocInvoice": false,
"currency": "USD",
"tax": 0,
"headerEntities": [
{
"entityCode": "NUUS",
"entityType": null
},
{
"entityCode": "0100",
"entityType": null
},
{
"entityCode": "132",
"entityType": null
}
],
"erpOrderType": 0,
"sourceSystemName": "KNA-SAP",
"orderTotal": 50300,
"orderDate": "2019-01-18T17:52:26",
"precision": 0,
"buyerVATNumber": null,
"supplierVATNumber": null,
"customAttributes": [],
"clientPartnerCode": "0080005119",
"clientContactCode": "CC1105202001",
"remitToLocation": {
"locationName": "SUNBELT RENTALS INC",
"locationNumber": null,
"address": {
"addressline1": "Please Enter Address",
"addressline2": "409211",
"addressline3": null,
"city": "ATLANTA",
"zipCode": "30384-9211",
"stateInfo": {
"stateAbbrevationCode": "GA",
"stateName": null
},
"countryInfo": {
"countryCode": "US",
"countryName": "United States"
},
"phoneNo1": "(606) 928-8118",
"extenstionNo1": null,
"phoneNo2": "",
"extenstionNo2": null,
"mobileNo": null,
"faxNo": "",
"county": null
},
"deliverTo": null,
"registrationDetails": []
},
"paymentTermsDetails": {
"noOfDays": 0,
"discount": 0,
"discountDays": 0,
"paymentTermCode": "NT75",
"paymentTermName": null
},
"itemTotalAmount": 0,
"shipping": -100,
"additionalCharges": 0,
"totalAmount": 0,
"comments": [
{
"commentText": "The MEMO SCRM-08:19-05855 HAS BEEN SCRM-08:19-05855 by Vishwas\n",
"accessType": null
}
],
"attachment": null,
"creditMemoItems": [
{
"buyerItemNumber": "002500000010001082",
"itemLineNumber": 1,
"description": "Glass Phone",
"itemType": "Material",
"unitPrice": 0,
"quantity": 10,
"uom": "EA",
"invoiceLineNumber": 0,
"poLineItemNumber": 1,
"itemTotalAmount": 0,
"creditAmount": 0,
"supplierPartId": "",
"additionalCharges": 0,
"tax": 0,
"shippingCharges": -100,
"manufacturerName": null,
"manufacturerPartNumber": null,
"billable": "no",
"comments": [],
"externalTax": 0,
"creditMemoItemTaxes": [],
"externalTaxes": [],
"customAttributes": null,
"documentItemShippingDetails": [],
"creditMemoSplitItems": [
{
"documentSplitItemEntities": [
{
"entityType": "Business Region",
"entityCode": "",
"entityDisplayName": ""
},
{
"entityType": "Source System",
"entityCode": "",
"entityDisplayName": ""
},
{
"entityType": "Item Category",
"entityCode": "Blank",
"entityDisplayName": "Standard"
},
{
"entityType": "Company Code",
"entityCode": "NUUS",
"entityDisplayName": "NUUS - Kellogg USA, Inc"
},
{
"entityType": "GL Code",
"entityCode": "",
"entityDisplayName": ""
},
{
"entityType": "Cost Center",
"entityCode": "",
"entityDisplayName": ""
},
{
"entityType": "Network",
"entityCode": "",
"entityDisplayName": ""
},
{
"entityType": "Internal Order",
"entityCode": "",
"entityDisplayName": ""
},
{
"entityType": "Plant",
"entityCode": "0393",
"entityDisplayName": "Mfg - Lancaster, PA"
},
{
"entityType": "Purchasing Org",
"entityCode": "0100",
"entityDisplayName": "NA Indirect"
},
{
"entityType": "Purchasing Group",
"entityCode": "132",
"entityDisplayName": "Lancaster Stores"
},
{
"entityType": "Account Assignment",
"entityCode": "",
"entityDisplayName": ""
},
{
"entityType": "Material Group Level 1",
"entityCode": "--",
"entityDisplayName": "--"
},
{
"entityType": "Material Group Level 2",
"entityCode": "--",
"entityDisplayName": "--"
},
{
"entityType": "Material Group Level 3",
"entityCode": "ELECCNTRL",
"entityDisplayName": "ELECTRIC CONTROL"
}
],
"splitItemTotal": 0,
"customAttributes": [],
"splitType": null,
"quantity": 0,
"percentage": 0
}
]
}
]
}
],
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
Error Scenario – Request
https://<Instance>/SmartInterfaceAPI/api/CreditMemo/GetCreditMemo
Error Scenario – Response (No Credit Memos Found)
{
"data": [],
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
|
SaveCreditMemo |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
|
Attachments object |
|
|
|
|
StatusCode |
|
String |
|
|
|
|
List of ErrorModel object |
|
|
|
|
|
List of SuccessModel object |
|
|
|
|
Data |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
|
basicDetails object |
Basic details of an object |
|
|
|
|
documentLobDetails object |
Document LOB details |
|
|
|
partnerMemoNumber |
|
string |
Partner Memo Number |
|
|
partnerInvoiceNumber |
|
string |
Partner invoice number |
|
|
invoiceReferenceNumber |
|
String |
Invoice Reference Number |
|
|
partnerName |
|
String |
Partner name |
|
|
partnerMemoDate |
|
DateTime |
Partner memo date |
|
|
memoReceivedDate |
|
DateTime |
Received date of memo |
|
|
orderNumber |
|
String |
Order number |
|
|
partnerInvoiceDate |
|
DateTime |
Partner invoice date |
|
|
documentOrigin |
|
String |
Origin of the document |
|
|
|
billtoLocation object |
Bill to location |
|
|
|
|
supplierContact object |
Supplier Contact |
|
|
|
|
buyerContact object |
Buyer Contact |
|
|
|
availableInvoiceTaxAmount |
|
Int |
Invoice tax amount |
|
|
Billable |
|
True |
|
|
|
isMultiDocInvoice |
|
True |
|
|
|
Currency |
|
String |
Amount details |
|
|
Tax |
|
Int |
|
|
|
|
headerEntities object |
Header level entities |
|
|
|
erpOrderType |
|
Int |
ERP order type |
|
|
sourceSystemName |
|
String |
Source system name |
|
|
orderTotal |
|
Int |
Order total |
|
|
orderDate |
|
DateTime |
Date of an order |
|
|
Precision |
|
Int |
Precision |
|
|
buyerVATNumber |
|
String |
Buyer VAT Number |
|
|
supplierVATNumber |
|
String |
Supplier VAT Number |
|
|
|
customAttributes |
Customize attributes |
|
|
|
clientPartnerCode |
|
String |
Client partner code |
|
|
clientContactCode |
|
String |
Client contact code |
|
|
|
remitToLocation |
|
|
|
|
|
paymentTermsDetails object |
Details for payment terms |
|
|
|
itemTotalAmount |
|
Int |
Total amount of an item |
|
|
Shipping |
|
Int |
Shipping details |
|
|
additionalCharges |
|
Int |
Additional charges |
|
|
totalAmount |
|
Int |
Total amount |
|
|
|
comments object |
Reason |
|
|
|
|
attachment object |
Attachment |
|
|
|
|
creditMemoItems object |
|
|
|
|
BasicDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
documentName |
|
string |
Name of the document |
|
|
documentNumber |
|
string |
Number of the document |
|
|
documentStatus |
|
string |
Status of the document |
|
|
documentCreator |
|
string |
Creator of the document |
|
|
createdOn |
|
string |
Date on which the document is created |
|
|
documentBu |
|
documentBu object |
|
|
|
|
documentLobDetails object |
|
|
|
|
operationName |
|
string |
|
|
|
DocumentLobDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
entityCode |
|
string |
Entity code |
|
|
entityType |
|
string |
EntityType |
|
|
BilltoLocation |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
locationName |
|
string |
Name of the location |
|
|
locationNumber |
|
string |
Location number |
|
|
|
address object |
Address |
|
|
|
deliverTo |
|
deliverTo |
string |
|
|
|
registrationDetails object |
Registration details |
|
|
|
Address |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
addressline1 |
|
string |
|
|
|
addressline2 |
|
string |
|
|
|
addressline3 |
|
string |
|
|
|
city |
|
string |
City name |
|
|
zipCode |
|
string |
Zip code |
|
|
|
stateInfo object |
|
|
|
|
|
countryInfo object |
|
|
|
|
phoneNo1 |
|
string |
|
|
|
extenstionNo1 |
|
string |
|
|
|
phoneNo2 |
|
string |
|
|
|
extenstionNo2 |
|
string |
|
|
|
mobileNo |
|
string |
Mobile number |
|
|
faxNo |
|
string |
Fax number |
|
|
county |
|
string |
Country name |
|
|
StateInfo |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
stateAbbrevationCode |
|
String |
State abbreviation code |
|
|
stateName |
|
String |
Name of the state |
|
|
CountryInfo |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
countryCode |
|
String |
Country code |
|
|
countryName |
|
String |
Name of the country |
|
|
RegistrationDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
companyIdentificationDisplayName |
|
String |
|
|
|
companyIdentification |
|
String |
|
|
|
SupplierContact |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
clientContactCode |
|
String |
|
|
|
emailAddress |
|
String |
|
|
|
firstName |
|
String |
|
|
|
lastName |
|
String |
|
|
|
BuyerContact |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
clientContactCode |
|
String |
|
|
|
emailAddress |
|
String |
|
|
|
firstName |
|
String |
|
|
|
lastName |
|
String |
|
|
|
HeaderEntities |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
entityCode |
|
string |
Entity code |
|
|
entityType |
|
true |
Entity Type |
|
|
CustomAttributes |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
questionnaireTitle |
|
String |
Title of the questionnaire |
|
|
|
List of questionnaireResponseValues |
Response value for the questionnaire |
|
|
|
QuestionnaireResponseValues |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
childQuestionSets |
|
List of customattributes |
|
|
|
columnText |
|
string |
|
|
|
responseValue |
|
string |
|
|
|
rowId |
|
string |
|
|
|
RemitToLocation |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
locationName |
|
string |
Location name |
|
|
locationNumber |
|
string |
Location number |
|
|
|
address object |
Address |
|
|
|
deliverTo |
|
string |
deliverTo |
|
|
|
registrationDetails object |
Registration details |
|
|
|
PaymentTermsDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
noOfDays |
|
int |
Number of days |
|
|
discount |
|
int |
|
|
|
discountDays |
|
int |
Discount days |
|
|
paymentTermCode |
|
string |
Payment term code |
|
|
paymentTermName |
|
string |
Payment term name |
|
|
Comments |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
commentText |
|
string |
|
|
|
accessType |
|
string |
|
|
|
Attachment |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
filename |
|
String |
File name |
|
|
fileUri |
|
string |
File URL |
|
|
attachmentData |
|
string |
Data in attachment |
|
|
Extension |
|
string |
Extension |
|
|
contentTransferEncoding |
|
string |
Content Transfer Encoding |
|
|
CreditMemoItems |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
itemNumber |
|
string |
Item number |
|
|
itemLineNumber |
|
int |
Line item number |
|
|
Description |
|
string |
Description for the credit memo items |
|
|
itemType |
|
string |
Item type |
|
|
unitPrice |
|
int |
Unit price |
|
|
Quantity |
|
int |
Volume |
|
|
Uom |
|
string |
Unit of measurement |
|
|
invoiceLineNumber |
|
int |
Line number for invoice |
|
|
poLineItemNumber |
|
int |
Line item number for purchase order |
|
|
itemTotalAmount |
|
int |
Item total amount |
|
|
creditAmount |
|
int |
Credit amount |
|
|
supplierPartId |
|
string |
|
|
|
additionalCharges |
|
int |
Additional charges |
|
|
Tax |
|
int |
Tax |
|
|
shippingCharges |
|
int |
Shipping charges |
|
|
manufacturerName |
|
string |
Manufacture name |
|
|
manufacturerPartNumber |
|
string |
Manufacture part number |
|
|
billable |
|
string |
|
|
|
|
List of comments object |
Reason |
|
|
|
externalTax |
|
decimal |
External tax |
|
|
|
List of creditMemoItemTax |
CreditMemo Item Taxes |
|
|
|
|
List of externalTaxes |
External Taxes |
|
|
|
|
List of customAttributes |
Custom Attributes |
|
|
|
|
List of documentItemShippingDetails object |
Shipping details for document item |
|
|
|
|
List of creditMemoSplitItems |
Credit memo split items |
|
|
|
CreditMemoItemTaxes |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
taxLevelType |
|
string |
Tax Level Type |
|
|
taxCode |
|
string |
Tax Code |
|
|
taxValue |
|
Decimal |
Tax Value |
|
|
taxMode |
|
string |
Tax Mode |
|
|
taxType |
|
string |
Tax Type |
|
|
taxDescription |
|
string |
Tax Description |
|
|
taxModeType |
|
string |
Tax Mode Type |
|
|
ExternalTaxes |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
taxRate |
|
Decimal |
Tax Rate |
|
|
taxCode |
|
string |
Tax Code |
|
|
taxValue |
|
Decimal |
Tax Value |
|
|
taxMode |
|
string |
Tax Mode |
|
|
taxType |
|
String |
Tax Type |
|
|
authorityName |
|
String |
Authority Name |
|
|
locationCode |
|
String |
Location Code |
|
|
taxRateCode |
|
String |
Tax Rate Code |
|
|
effectiveTaxLevel |
|
String |
Effective Tax Level |
|
|
officialName |
|
String |
Official Name |
|
|
taxBase |
|
String |
Tax Base |
|
|
|
taxAddress object |
Tax Address |
|
|
|
TaxAddress |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
addressline1 |
|
string |
|
|
|
addressline2 |
|
string |
|
|
|
addressline3 |
|
string |
|
|
|
city |
|
string |
City name |
|
|
zipCode |
|
string |
Zip code |
|
|
|
stateInfo object |
|
|
|
|
|
countryInfo object |
|
|
|
|
phoneNo1 |
|
string |
|
|
|
extenstionNo1 |
|
string |
|
|
|
phoneNo2 |
|
string |
|
|
|
extenstionNo2 |
|
string |
|
|
|
mobileNo |
|
string |
Mobile number |
|
|
faxNo |
|
string |
Fax number |
|
|
county |
|
string |
Country name |
|
|
DocumentItemShippingDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
|
shiptoLocation object |
|
|
|
|
|
delivertoLocation object |
|
|
|
|
shippingMethod |
|
string |
|
|
|
ShiptoLocation |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
locationName |
|
string |
Location name |
|
|
locationNumber |
|
string |
Location number |
|
|
|
address object |
Address |
|
|
|
deliverTo |
|
string |
Deliver To |
|
|
|
registrationDetails object |
Registration details |
|
|
|
DelivertoLocation |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
locationName |
|
string |
Location name |
|
|
locationNumber |
|
string |
Location number |
|
|
|
address object |
Address |
|
|
|
deliverTo |
|
string |
Deliver To |
|
|
|
registrationDetails object |
Registration details |
|
|
|
CreditMemoSplitItems |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
|
List of documentSplitItemEntities |
|
|
|
|
splitItemTotal |
|
Decimal |
|
|
|
|
List of Custom attributes object |
|
|
|
|
splitType |
|
Decimal |
|
|
|
Quantity |
|
Decimal |
|
|
|
percentage |
|
Decimal |
|
|
|
DocumentSplitItemEntities |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
entityCode |
|
string |
Entity code |
|
|
entityType |
|
string |
Entity type |
|
|
entityDisplayName |
|
string |
Display name for an entity |
|
|
ErrorDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
Key |
|
String |
|
|
|
|
List of Error object |
|
|
|
|
Errors |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
ErrorCode |
|
String |
|
|
|
ErrorDescription |
|
String |
|
|
|
SuccessDetails |
||||
|
Property |
Required? |
Data type |
Description |
Validations/Exceptions |
|
Key |
|
String |
|
|