/
Configuration Guide Kazakhstan CEDM Connector

Configuration Guide Kazakhstan CEDM Connector

Owned by Pavel Kanskov
Last updated: May 13, 2025

Document History

Version

Changes

Effective Date

1.0

First approved version

01-Feb-2024

2.0

Updated with Release 2024_02

01-May-2024

3.0

Updated with Release 2024_03

01-Aug-2024

4.0

Updated with Release 2024_04

01-Nov-2024

5.0

Updated with Release 2025_01

01-Feb-2025

 

About This Guide

This document describes configuration steps that are required, or are optionally possible, to configure 3Keys Kazakhstan CEDM in SAP ATTP system.

Solution overview

SAP ATTP delivers a solution to generate the reporting messages for Kazakhstan CEDM system. The 3Keys Kazakhstan CEDM Add-On automate the communication and message generation/transfer to Kazakhstan CEDM system, visualize the message processing status with monitoring transaction.

Solution scope

In 3Keys Kazakhstan CEDM, the following notifications are supported:

Rule

Notification

Z3KKZ_EDO

Reg.Rep.Kazakhstan CEDM - General rule

Z3KKZ_EDO_0001

Reg.Rep.Kazakhstan CEDM - Act of acceptance Single Distrib.

Z3KKZ_EDO_0002

Reg.Rep.Kazakhstan CEDM - Import EAEU notification

Z3KKZ_EDO_0003

Reg.Rep.Kazakhstan CEDM - Import 3rd countries

Z3KKZ_EDO_0004

Reg.Rep.Kazakhstan CEDM - Write Off

Z3KKZ_EDO_0005

Reg.Rep.Kazakhstan CEDM - Return into circulation

Z3KKZ_EDO_0010

Reg.Rep.Kazakhstan CEDM - Act of acceptance

Z3KKZ_EDO_0011

Reg.Rep.Kazakhstan CEDM - Report codes transfer fr. non-resid

Z3KKZ_EDO_0092

Reg.Rep.Kazakhstan CEDM - Aggregation Edit

Z3KKZ_EDO_6000

Reg.Rep.Kazakhstan CEDM - Aggregation

Z3KKZ_EDO_CHANGE_HRY

Reg.Rep.Kazakhstan CEDM - Change Hierarchy

 The list of supported rule types (notifications) is planned to be enhanced in future 3Keys Kazakhstan CEDM releases. Also, you can enhance supported notification by adding custom rule types (See enhancement section).

Constraints, Assumptions, Prerequisites and Dependencies

The Kazakhstan reporting part for CEDM is configured in SAP ATTP.

Setting up the Solution

Connection to Java part

The connector Java part as SaaS solution supports HTTPS communication using web services.

The Root CA certificate of the certificate which is used to secure the connection from ATTP or middleware system to connector Java part, should be added to the SSL client (Anonymous) in the transaction STRUST.

The corporate firewall, proxy, gateway, etc. should allow outbound HTTPS connection from ATTP or middleware system to the Connector Java part.

Prerequisites

For setting up an online integration to a Kazakhstan reporting system via CEDM connector Java part, do the following:

·       Create an HTTP Destination to CEDM connector.

·       Create a System (master data).

·       Maintain settings.

Create an HTTP Destination to CEDM connector

To create an HTTP connection to the external server, do the following:

  • Call transaction SM59

  • Create a new destination as follows

    • Name for the destination: KAZ_3KEYS_CEDM

    • Connection Type: G – HTTP Connection to External Server

    • Description: Maintain a description for the destination (for example CEDM via 3Keys Kazakhstan connector)

On the tab Technical Settings, maintain the URL in the fields Target Host, Service No. and Path Prefix.

  • Target Host: [URL provided by 3Keys support]

  • Service No.: 443

  • Path Prefix: /app/edo/api

Set the HTTP Proxy Options as required in your organizations network

On tab Logon & Security, do the following:

  • Basic Authentication: true

  • Input User and password for CEDM Connector

  • Do Not Send Logon Ticket: true

  • SSL: active, Anonymous

On the tab Special Options, do the following:

  • HTTP Version: HTTP 1.1

  • Compression: Inactive

  • Compressed Response: Yes

  • Accept Cookies: No

Save the destination.

Click on Connection Test to test the created destination. If the connector and reporting system is reachable and the destination is set up correctly, the test result shows that the HTTP response value is 200 and Text is OK.

Create an HTTP Destination to 3Keys SaaS connector API

To create an HTTP connection to the external server, do the following:

  • Call transaction SM59

  • Create a new destination as follows

    • Name for the destination: KAZ_3KEYS_API

    • Connection Type: G – HTTP Connection to External Server

    • Description: Maintain a description for the destination (for example 3Keys Kazakhstan connector API)

On the tab Technical Settings, maintain the URL in the fields Target Host, Service No. and Path Prefix.

  • Target Host: [URL provided by 3Keys support]

  • Service No.: 443

  • Path Prefix: /app

Set the HTTP Proxy Options as required in your organizations network

On tab Logon & Security, do the following:

  • Basic Authentication: true

  • Input User and password for CEDM Connector

  • Do Not Send Logon Ticket: true

  • SSL: active, Anonymous

On the tab Special Options, do the following:

  • HTTP Version: HTTP 1.1

  • Compression: Inactive

  • Compressed Response: Yes

  • Accept Cookies: No

Save the destination.

Click on Connection Test to test the created destination. If the connector and reporting system is reachable and the destination is set up correctly, the test result shows that the HTTP response value is 200 and Text is OK.

 

Create a system for CEDM

To create a system, do the following:

  • Call transaction /STTP/COCKPIT

  • Navigate to Master Data > Systems and then Choose Display/Edit.

  • Choose Create. A popup is displayed. 

  • In the popup, define a system name and use following parameters: 

    • System name (for example KAZ_CEDM)

    • System Type: F - Foreign Reporting System

    • Communication Type: 0 – Not Specified

    • RFC Destination: Maintain the destination name created in SM59 with path /app/edo/api

Create a system for CEDM API

To create a system, do the following:

  • Call transaction /STTP/COCKPIT

  • Navigate to Master Data > Systems and then Choose Display/Edit.

  • Choose Create. A popup is displayed. 

  • In the popup, define a system name and use following parameters: 

    • System name (for example KAZ_CEDM_API)

    • System Type: F - Foreign Reporting System

    • Communication Type: 0 – Not Specified

    • RFC Destination: Maintain the destination name created in SM59 with path /app

Technical user and authorization role

One technical user shall be created in ATTP and have authorization to execute web service calls.

Maintain service paths

Check and, if needed, maintain the service paths in the view /STTP/V_RSRVPATH via transaction SM30. Industry 20 is default industry for methods, correct product group depends on industry and added before True API request execution

Industry

Identifier

RU System

RU System Revision

REST Operation

REST Path

20

NTF (Notification System)

600

EDO_CREATE_DOC

/apiUot/api/v1/private/create-doc

20

NTF (Notification System)

600

EDO_DATA_FOR_SIGN

/apiUot/api/v1/private/getDataForSign

20

NTF (Notification System)

600

EDO_DELETE_DRAFT

/apiUot/api/v1/private/draft/{docID}

20

NTF (Notification System)

600

EDO_DOC_ACCEPT

/apiUot/api/v1/private/document/accept

20

NTF (Notification System)

600

EDO_DOC_LIST

/apiUot/api/v1/private/doc-list

20

NTF (Notification System)

600

EDO_DOC_REJECT

/apiUot/api/v1/private/document/reject

20

NTF (Notification System)

600

EDO_EDIT_AGGREGATE

/apiUot/api/v1/private/aggregate/edit

20

NTF (Notification System)

600

EDO_GET_AGGREGATE

/apiUot/api/v1/private/aggregate/{code}

20

NTF (Notification System)

600

EDO_GET_DOC_CODES

/apiUot/api/v2/private/document/codes/{docID}

20

NTF (Notification System)

600

EDO_GET_DOC_ERRORS

/apiUot/api/v2/private/marks-error/{docID}

20

NTF (Notification System)

600

EDO_GET_DOC_GTIN

/apiUot/api/v1/private/document/gtin/{docId}

20

NTF (Notification System)

600

EDO_GET_TOKEN

/apiUot/api/v1/private/get-token

20

NTF (Notification System)

600

EDO_INFO_KM

/apiUot/api/v1/private/info-km

20

NTF (Notification System)

600

EDO_PROF_DOC

/apiUot/api/v2/private/profile-doc

20

NTF (Notification System)

600

EDO_PROF_OUT_DOC

/apiUot/api/v1/private/profile-out-doc

20

NTF (Notification System)

600

EDO_SEND_SIGNED

/apiUot/api/v1/private/sendSigned

20

NTF (Notification System)

600

EDO_UPD_DOC_GTIN

/apiUot/api/v1/private/document/gtin/{docId}

Event additional properties

The following is a list of expected event properties to compose the notification message. The notification raise error in case the mandatory event properties is not available on the event.

Import from EAEU

Property

Description

Mandatory?

ZR_KZ_CONS_ID

IIN/BIN of the recipient

N

ZR_KZ_SUPPL_ID

Supplier Identifier taxpayer (TIN, IIN, BIN etc.) sender or equivalent

N

ZR_KZ_SUPPL_NAME

Sender name

N

ZR_KZ_CTR_CODE

Country EAEU of export

N

ZR_KZ_PRM_DOC_NUM

Document number

N

ZR_KZ_PRM_DOC_DATE

Document date in the format

YYYY-MM-DD

N

Import from 3rd countries

Property

Description

Mandatory?

ZR_KZ_CONS_ID

IIN/BIN of the recipient

N

ZR_KZ_CTR_CODE

Country of export according to the directory of countries

N

ZR_KZ_DECL_DOCUMENT

Customs document type (“DECLARATION”, “STATEMENT”)

N

ZR_KZ_DECL_NUM

Customs registration document number

N

ZR_KZ_DECL_DATE

Customs registration document date

N

ZR_KZ_DECISION_CODE

Customs decision code

N

ZR_KZ_DECISION_DATE

Customs decision date time in the ISO format YYYY-MM-DDTHH:MM:SSZ

N

ZR_KZ_CUSTOMS_CODE

Customs code

N

ZR_KZ_CERT_DOCUMENT

Certification document type

N

ZR_KZ_CERT_DOC_NUM

Certification document number

N

ZR_KZ_CERT_DOC_DATE

Certification document date

N

ZR_KZ_PRM_DOC_NUM

Paper document number

N

ZR_KZ_PRM_DOC_DATE

Date of paper document Notifications in the format

YYYY-MM-DD

N

Write off

Property

Description

Mandatory?

ZR_KZ_SUPPL_ID

Identifier taxpayer (TIN, IIN, BIN etc.) sender or equivalent

N

ZR_KZ_REASON

Withdrawal reason

N

ZR_KZ_PRM_DOC_NAME

Document name

N

ZR_KZ_PRM_DOC_NUM

Document number

N

ZR_KZ_PRM_DOC_DATE

Document date

N

Return into circulation

Property

Description

Mandatory?

ZR_KZ_SUPPL_ID

Identifier taxpayer (TIN, IIN, BIN etc.) sender or equivalent

N

ZR_KZ_REASON

Introduce reason

N

ZR_KZ_PRM_DOC_NAME

Document name

N

ZR_KZ_PRM_DOC_NUM

Document number

N

ZR_KZ_PRM_DOC_DATE

Document date

N

Report codes transfer from non-resident

Property

Description

Mandatory?

ZR_KZ_CTR_CODE

Country of export according to the directory of countries

N

ZR_KZ_SHIP_DATE

Shipment date in the format

YYYY-MM-DD

N

ZR_KZ_SUPPL_ID

Identifier taxpayer (TIN, IIN, BIN etc.) sender or equivalent

N

ZR_KZ_CONS_ID

IIN/BIN of the recipient

N

ZR_KZ_PRM_DOC_NUM

Document number

N

ZR_KZ_PRM_DOC_DATE

Document date

N

Act of acceptance

Property

Description

Mandatory?

ZR_KZ_PRM_DOC_NUM

Document number

N

ZR_KZ_PRM_DOC_DATE

Document date

N

ZR_KZ_SUPPL_ID

Sender Bin

N

ZR_KZ_CONS_ID

Receiver Bin

N

Act of acceptance Single distributor

Property

Description

Mandatory?

ZR_KZ_PRM_DOC_NUM

Document number

N

ZR_KZ_PRM_DOC_DATE

Document date

N

ZR_KZ_SUPPL_ID

Sender Bin

N

ZR_KZ_CONS_ID

Receiver Bin

N

New aggregation out of production

Property

Description

Mandatory?

ZR_KZ_PACKAGE_TYPE

Package Type

N

Product / GTIN properties

The following product / GTIN properties can be maintained for trade items.

Property

Value

 

Description

Property

Value

 

Description

ZKZ_PRICE

Numeric value

Example: 1000

Optional

Notification price in currency KZT common for all notifications (optional parameter)

ZKZ_PRICE_0001

Numeric value

Example: 1000

Optional

Notification price in currency KZT for Act of acceptance Single Distributor (optional parameter)

ZKZ_PRICE_0002

Numeric value

Example: 1000

Optional

Notification price in currency KZT for Import from EAEU (optional parameter)

ZKZ_PRICE_0003

Numeric value

Example: 1000

Optional

Notification price in currency KZT for Import from 3rd countries (optional parameter)

ZKZ_PRICE_0004

Numeric value

Example: 1000

Optional

Notification price in currency KZT for Write Off (optional parameter)

ZKZ_PRICE_0005

Numeric value

Example: 1000

Optional

Notification price in currency KZT for Return into circulation (optional parameter)

ZKZ_PRICE_0010

Numeric value

Example: 1000

Optional

Notification price in currency KZT for Act of acceptance (optional parameter)

Business partner company registrations

The following company registrations can be maintained for the business partners.

Property

Description

Value

ZKZ_PARTIC

Ident. Number of Taxpayer KZ

Example: 850702450693

ZKZ_SDISTR

Single Distributor indicator

X (optional parameter)

ZKZ_PAR_T

Indicator to define business partner or location name to be shown in CEDM monitor transaction if the same BIN number is maintained on multiple business partners or locations

X (optional parameter)

Customizing the solution

In general, customizing is performed with following transactions:

  • /K3TKZ/EDO_PARAM - Reporting parameters

  • /K3TKZ/EDO_CUST - Reporting customizing

  • /K3TKZ/EDO_CONF - Reporting configuration

  • /K3TKZ/EDO_ATTR_MAP - Reporting attributes mapping

General Customizing

The transaction /K3TKZ/EDO_PARAM contains parameters to influence the 3Keys Kazakhstan CEDM. The settings will require a customizing transport.

Name

Description, Values

DOC_TYPE_CUSTOM

Default Customs Document type for notification “Import from 3rd countries”. Optional value

Example: DECLARATION

DOC_TYPE_0003

Default Document type for notification “Import from 3rd countries”. Optional value

Example: сертификат соответствия

DECISION_CODE

Customs decision code for notification “Import from 3rd countries”. Optional value

Example: 10

DOC_INB_DELAY