Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

 

Table of Contents

About This Guide

...

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}

...

Property

Description

Mandatory?

ZR_KZ_PACKAGE_TYPE

Package Type

N

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”

Example: DECLARATION

...

DOC_TYPE_0003

...

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

...

DECISION_CODE

...

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

Example: 10

...

EDO_SYSTEM

...

ATTP System name (with assigned RFC with path /app/edo/api )

Example: CEDM

...

EDO_SYSTEM_API

...

ATTP System name for internal Connector calls (with assigned RFC without path /app/edo/api )

Example: CEDM_API

...

MON_CHANGE_DOC_INACTIVE

...

Deactivate Change Log functionality

X – deactivate

...

MON_HDR_AREA

...

Set header area size for transaction /K3TKZ/EDO_MONITOR

...

SEQ_MAX_LOG_ROWS

...

Maximum entries for sequence check result screen

...

SINGLE_DISTR_BIN

...

Single distributor Bin

...

OMS_STATUS_CHECK_DELAY

...

Delay in seconds before first CEDM status check after sending usage report to OMS system

Example 300

...

PRICE_RELEV_0001

...

Enable pricing information for Act of acceptance Single distributor (type 0001)

...

PRICE_RELEV_0002

...

Enable pricing information for Introduce from EAEU (type 0002)

...

PRICE_RELEV_0003

...

Enable pricing information for Import from 3rd countries (type 0003)

...

PRICE_RELEV_0004

...

Enable pricing information for Write off notification (type 0004)

...

PRICE_RELEV_0005

...

Enable pricing information for Return into circulation (type 0005)

...

PRICE_RELEV_0010

...

Product / GTIN properties

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

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

Delay in seconds to debug inbound message processing via SM50. Optional value

Example: 30

DOC_INB_LIST_LIMIT

Limit value for inbound document list request. Optional value, if value is not maintained default value 1000 used

Example: 200

EDO_SYSTEM

ATTP System name (with assigned RFC with path /app/edo/api )

Example: CEDM

EDO_SYSTEM_API

ATTP System name for internal Connector calls (with assigned RFC without path /app/edo/api )

Example: CEDM_API

EDO_TIMEZONE

CEDM system timezone to request inbound document. Optional value, if value is not maintained default value UTC+5 used

Example: UTC+5

MAX_LOG_OBJID_ERR_ROWS

Maximum entries for inbound objects processing error log. Optional value, if value is not maintained default value 999999 used

Example: 100

MON_CHANGE_DOC_INACTIVE

Deactivate Change Log functionality. Optional value

X – deactivate

MON_HDR_AREA

Set header area size (percentage) for transaction /K3TKZ/EDO_MONITOR. Optional value, if value is not maintained default value 70 used

Example: 50

SEQ_MAX_LOG_ROWS

Maximum entries for sequence check result screen. Optional value, if value is not maintained default value 50 used

Example: 20

SEQ_EXEC_ONLCHK_0001

Execute online check for SSCC pallets from notification at CEDM system for Act of acceptance Single distributor (type 0001). Expected result: object exists with child objects prefix “00”. Optional value.

Example: X

SEQ_EXEC_ONLCHK_0002

Execute online check for SSCC pallets from notification at CEDM system for Introduce from EAEU (type 0002). Expected result: object exists with child objects prefix “00”. Optional value.

Example: X

SEQ_EXEC_ONLCHK_0003

Execute online check for SSCC pallets from notification at CEDM system for Import from 3rd countries (type 0003). Expected result: object exists with child objects prefix “00”. Optional value.

Example: X

SEQ_EXEC_ONLCHK_0010

Execute online check for SSCC pallets from notification at CEDM system for Act of acceptance (type 0010). Expected result: object exists with child objects prefix “00”. Optional value.

Example: X

SEQ_EXEC_ONLCHK_0011

Execute online check for SSCC pallets from notification at CEDM system for Report from non-resident (type 0011). Expected result: object exists with child objects prefix “00”. Optional value.

Example: X

SINGLE_DISTR_BIN

Single distributor Bin. Mandatory value

Example: 090340007747

OMS_STATUS_CHECK_DELAY

Delay in seconds before first CEDM status check after sending usage report to OMS system

Example 300

PRICE_RELEV_0001

Enable pricing information for Act of acceptance Single distributor (type 0001). Mandatory value

Example: X

PRICE_RELEV_0002

Enable pricing information for Introduce from EAEU (type 0002). Mandatory value

Example: X

PRICE_RELEV_0003

Enable pricing information for Import from 3rd countries (type 0003). Mandatory value

Example: X

PRICE_RELEV_0004

Enable pricing information for Write off notification (type 0004). Mandatory value

Example: X

PRICE_RELEV_0005

Enable pricing information for Return into circulation (type 0005). Mandatory value

Example: X

PRICE_RELEV_0010

Enable pricing information for Act of acceptance (type 0010). Mandatory value

Example: X

SPLIT_MAXOCC_0001

Maximum objects for Act of acceptance Single distributor (type 0001). Optional value, if value is not maintained default value 5000 used

Example: 500

SPLIT_MAXOCC_0002

Maximum objects for Introduce from EAEU (type 0002). Optional value, if value is not maintained default value 5000 used

Example: 500

SPLIT_MAXOCC_0003

Maximum objects for Import from 3rd countries (type 0003). Optional value, if value is not maintained default value 5000 used

Example: 500

SPLIT_MAXOCC_0004

Maximum objects for Write off notification (type 0004). Optional value, if value is not maintained default value 5000 used

Example: 500

SPLIT_MAXOCC_0005

Maximum objects for Return into circulation (type 0005). Optional value, if value is not maintained default value 5000 used

Example: 500

SPLIT_MAXOCC_0010

Maximum objects for Act of acceptance (type 0010). Optional value, if value is not maintained default value 5000 used

Example: 500

SPLIT_MAXOCC_0011

Maximum objects for Report from non-resident (type 0011). Optional value, if value is not maintained default value 5000 used

Example: 500

SPLIT_MAXOCC_INFO

Maximum objects for single code information API request from CEDM system. Optional value, if value is not maintained default value 5000 used

Example: 500

Following the recommended minimum set of parameters

Name

Value

EDO_SYSTEM

Example: CEDM

EDO_SYSTEM_API

Example: CEDM_API

SINGLE_DISTR_BIN

090340007747

PRICE_RELEV_0001

X

PRICE_RELEV_0002

X

PRICE_RELEV_0003

X

PRICE_RELEV_0004

X

PRICE_RELEV_0005

X

PRICE_RELEV_0010

X

Customizing for Reports

Relevant industry

...

Participant tax code fields could be filled with value from source or destination fields of the EPCIS event or business transaction in the transaction /K3TKZ/EDO_ATTR_MAP .

The following location data source is supported:

...