GetAttachmentByCreditMemoNumber (GET) | GEP TECH DOCUMENTATION

Overview

This GET API allows retrieval of Attachment by Credit Memo Number details created in GEP SMART to post them into ERP.

URL Format: https://<Instance>/SmartInterfaceAPI/api/CreditMemo/AttachmentByCreditMemoNumber

Request

https://<Instance>/SmartInterfaceAPI/api/CreditMemo/AttachmentByCreditMemoNumber?CreditMemoNumber=CM-07:16-00025

Response

{
   "data": [
      {
         "documentNumber": "String",
         "partnerCode": "String",
         "attachmentData": "String",
         "name": "String",
         "contentType": "String",
         "extension": "String",
         "attachmentType": "String"
      }
   ],
   "statusCode": "String",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

Examples

Success Scenario - Request
Request below describes that this contains only the mandatory attributes:

https://<Instance>/SmartInterfaceAPI/api/CreditMemo/AttachmentByCreditMemoNumber?CreditMemoNumber=CM-07:16-00025

Success Scenario - Response

{
   "data": {
      "documentNumber": "CM-07:16-00025",
      "partnerCode": null,
      "attachmentData": "<Attachment as Binary Code>",
      "name": "Credit-Memo-Template.png",
      "contentType": "image/png",
      "extension": ".png",
      "attachmentType": null
   },
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "CM-07:16-00025"
      }
   ]
}

Data Elements

	Get Attachment by Credit Memo Number
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Data		Attachments 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	DocumentNumber		String	Document Number
2	PartnerCode		String	Partner Code
3	AttachmentData		Byte	Attachment Data
4	Name		String	Attachment Name

	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