SaveApprovalDetails (POST)

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

This POST API allows pushing approval details into GEP SMART for further processing.
 

URL Format: https://<Instance>/smartInterfaceAPI/api/contact/Approvaldetails

Request 
[
   {
      "ContactCode": "string",
      "Key": "string",
      "currencyCode": "string",
      "authorityAmount": 0,
      "authorityAmountInBaseCurrency": 0,
      "startDate": "2019-11-26T14:59:02.358Z",
      "endDate": "2019-11-26T14:59:02.358Z",
      "IsActive": false,
      "Additionalfields": [
         {
            "fieldName": "string",
            "fieldValue": "string"
         },
         {
            "fieldName": "string",
            "fieldValue": "string"
         },
         {
            "fieldName": "string",
            "fieldValue": "string"
         }
      ]
   }
]

 

Response 
{
  "data": {},
  "statusCode": "string",
  "errorDetails": [
    {
      "key": "string",
      "errors": [
        {
          "errorCode": "string",
          "errorDescription": "string"
        }
      ]
    }
  ],
  "successDetails": [
    {
      "key": "string"
    }
  ]
}

 

Examples

Success Scenario - Request 

[
	{
	"ContactCode": "CC-2020.004664",
	"Key":"12",
	"currencyCode": "RSD",
	"authorityAmount": 169.3456,
	"authorityAmountInBaseCurrency": 0.0,
	"startDate": null,
	"endDate": "4/24/2020",
	"IsActive":true,
	"Additionalfields": [
		{
		"fieldName": "CommodityCode",
		"fieldValue": "New record1"
	},
	{
		"fieldName": "CommodityName",
		"fieldValue": "CCN2"
	},
	{
		"fieldName": "CountryCode",
		"fieldValue": "all"
	}]
}
]

Success Scenario – Response

{
  "data": null,
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": [
    {
      "key": "12"
    }
  ]
}

Error Scenario – Request

[
	{
	"ContactCode": "",
	"Key":"12",
	"currencyCode": "RSD",
	"authorityAmount": 169.3456,
	"authorityAmountInBaseCurrency": 0.0,
	"startDate": null,
	"endDate": "4/24/2020",
	"IsActive":true,
	"Additionalfields": [
		{
		"fieldName": "CommodityCode",
		"fieldValue": "New record1"
	},
	{
		"fieldName": "CommodityName",
		"fieldValue": "CCN2"
	},
	{
		"fieldName": "CountryCode",
		"fieldValue": "all"
	}]
}
]

Error Scenario – Response

{
  "data": null,
  "statusCode": "400",
  "errorDetails": [
    {
      "key": "12",
      "errors": [
        {
          "errorCode": "MandatoryException",
          "errorDescription": " Contact Code is mandatory."
        }
      ]
    }
  ],
  "successDetails": []
}

 

Data Elements

AuthorityDetails

Property

Required?

Data type

Description

Validations / Exceptions

Key

Yes

String

DelegationId of Authoritydetails

Key is mandatory.

ContactCode

Yes

string

ContactCode of Authoritydetails

Contact Code is mandatory.

Currency Code

Yes

string

CurrencyCode of Authoritydetails

CurrencyCode is mandatory.

AuthorityAmount

Yes

Decimal

AuthorityAmount of Authoritydetails

AuthorityAmount is mandatory.

AuthorityAmountInBaseCurrency

No

Decimal

AuthorityAmountInBaseCurrency of AuthorityDetails

  

StartDate

Yes

Datetime

StartDate of AuthorityDetails

AuthorityAmount is mandatory.

EndDate

No

Datetime

EndDate of Authoritydetails

  

IsActive

No

Boolean

IsActive of AuthorityDetails

  

AdditionalFields

Yes

List of FieldDetails

    

Additional Fields

Property

Required?

Data type

Description

Validations / Exceptions

FieldName

Yes

String

Field Name of Additional Fields

Mandatory or not based on Mapping Table.

FieldValue

Yes

String

If sourceType is Org entity, then FieldName is Entity Type

Mandatory or not based on Mapping Table.