Transferring Payment Transactions to ERP

Description

Used to mark payment transactions as transferred to the ERP. On a successful call, the vposTransactionDetails.erpTransactionCode and vposTransactionDetails.erpTransactionCodeUpdateDate fields of the related transaction are set. The service is idempotent; records that have already been marked are not updated again.

• URL: /api/setPaymentErpCode
• Method: PUT
• Header: Authorization: Bearer <AccessToken> (See: 2.1 Creating an AccessToken) Content-Type: application/json
• Filters: (This service performs a marking operation; instead of query filters, it accepts parameters in the request body.)

Request Body

The following fields are sent:

Parameter	Type	Required	Description
referenceCode	string	Yes	Netahsilat transaction reference
erpTransactionCode	string	Yes	Transaction code sent to the ERP

Response Structure

The operation result is returned as a summary. Array items contain the following fields:

Field	Type	Description
ReferenceCode	string	Netahsilat transaction reference
ClientReferenceCode	string	Reference defined by the customer (if any)
ErpTransactionCode	string	null	Transaction/accounting code used in the ERP
Message	string	Result message: “Successful”, “Previously Transferred”, “Record Not Found”
MessageCode	string	Result code: "00" (Successful), "100" (Info/Warning)

Notes

• The “Previously Transferred” message indicates that the record has already been marked; no update is performed again (idempotent behavior).

• After marking, you can verify that the ERP fields are populated by querying with GetPayments.

• For error cases, see 4. General Error Model & Codes.

Sample Response

[  
  {  
    "ReferenceCode": "NT78451238475",  
    "ClientReferenceCode": "NT78451238475",  
    "ErpTransactionCode": "120.01.1020",  
    "Message": "Successful",  
    "MessageCode": "00"  
  },  
  {  
    "ReferenceCode": "NT78451238475",  
    "ClientReferenceCode": "NT78451238475",  
    "ErpTransactionCode": "120.01.1020",  
    "Message": "Previously Transferred",  
    "MessageCode": "100"  
  },  
  {  
    "ReferenceCode": "NT78451238475",  
    "ClientReferenceCode": "NT78451238475",  
    "ErpTransactionCode": null,  
    "Message": "Record Not Found",  
    "MessageCode": "100"  
  }  
]

Sample CURL

curl --location 'https://test_erpproxy.ecozum.com/api/setPaymentErpCode' \  
  -X PUT \  
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \  
  --header 'Content-Type: application/json' \  
  --data '{  
    "referenceCode": "NTH2P00000001926",  
    "erpTransactionCode": "DENEMEAktarim"  
  }'