{"id":4166,"date":"2024-05-01T13:30:23","date_gmt":"2024-05-01T11:30:23","guid":{"rendered":"https:\/\/modulus.help\/kb\/docs\/documentation\/cash-apis-v1\/api-create-transaction\/"},"modified":"2024-12-26T14:48:54","modified_gmt":"2024-12-26T12:48:54","slug":"api-create-transaction","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/cash-apis-v1\/api-create-transaction\/","title":{"rendered":"API: Create Transaction"},"content":{"rendered":"

The purpose of this API is to create new transaction.<\/p>\n

Request<\/h4>\n\n\n\n\n\n\n\n\n
URL<\/th>\nhttps:\/\/your_account.modulus.biz\/api\/csh\/v1\/Transaction?token=YOUR_TOKEN<\/td>\n<\/tr>\n
API Name<\/th>\nTransaction<\/td>\n<\/tr>\n
Method<\/th>\nPOST<\/td>\n<\/tr>\n
Source<\/th>\nThird Party Server<\/td>\n<\/tr>\n
Recipient<\/th>\nmodulus\u00ae Server<\/td>\n<\/tr>\n
Content Type<\/th>\napplication\/json<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Query String Parameters<\/h4>\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
token<\/th>\nYes<\/td>\nText<\/td>\nYour authentication token.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Payload Parameters<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
account_code<\/th>\nYes<\/td>\nText<\/td>\nThe code of the cash account used in the transaction.<\/td>\n<\/tr>\n
date<\/th>\nYes<\/td>\nDate<\/td>\nDate format must be ISO 8601 (Example: \u201c2020-01-10\u201d) and can not be in the future.<\/td>\n<\/tr>\n
amount<\/th>\nYes<\/td>\nDecimal<\/td>\nThe amount of the the transaction in account currency.<\/td>\n<\/tr>\n
cash_book_id<\/th>\nYes<\/td>\nNumber<\/td>\nRefers to cash book used for the transaction.<\/td>\n<\/tr>\n
\n
\n
transaction_nature<\/div>\n<\/div>\n<\/th>\n
Yes<\/td>\nText<\/td>\nRefers to the transaction nature of the transaction, possible values ( LKP_ENUM_CASH_IN, LKP_ENUM_CASH_OUT)<\/td>\n<\/tr>\n
counter_party<\/th>\nYes<\/td>\nText<\/td>\nRefers to other party of the transaction.<\/td>\n<\/tr>\n
related_party<\/th>\nNo<\/td>\nObject<\/td>\nObject with the info of counter party provided either customer or supplier. The structure explained here.<\/td>\n<\/tr>\n
account_exchange_rate<\/th>\nNo<\/td>\nDecimal Number<\/td>\nThe exchange rate of the account currency when the transaction is created. Mandatory if the account has foreign currency.<\/td>\n<\/tr>\n
\n
\n
counter_party_exchange_rate<\/div>\n<\/div>\n<\/th>\n
No<\/td>\nDecimal Number<\/td>\nThe exchange rate of the pay party currency when the transaction is created. Mandatory if the pay party has foreign currency differs the account currency.<\/td>\n<\/tr>\n
reference<\/th>\nNo<\/td>\nText<\/td>\nTransaction reference.<\/td>\n<\/tr>\n
description<\/th>\nNo<\/td>\nText<\/td>\nTransaction description.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/h3>\n

Customer Parameter details<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
code<\/th>\nYes<\/td>\nText<\/td>\nThe code of the related party used in the transaction.<\/td>\n<\/tr>\n
name<\/th>\nYes<\/td>\nText<\/td>\nThe name of the related party used in the transaction.<\/td>\n<\/tr>\n
type<\/th>\nYes<\/td>\nText<\/td>\nThe Type of the related party used in the transaction.
Possible values are: individual<\/strong> or organization<\/strong>.<\/td>\n<\/tr>\n
tax_registration_number<\/th>\nNo<\/td>\nNumber<\/td>\nRelated party’s Tax Registration Number.<\/td>\n<\/tr>\n
account_code<\/th>\nNo<\/td>\nText<\/td>\nThe code of the cash account of the related party.<\/td>\n<\/tr>\n
price_list_code (for counter parties of type customer)<\/th>\nNo<\/td>\nNumber<\/td>\nThe code of the price list of the related party.
It must have the same currency as the customer and account.<\/td>\n<\/tr>\n
address<\/th>\nNo<\/td>\nObject<\/td>\nThe address of the related party. The structure is explained elsewhere.<\/td>\n<\/tr>\n
contact<\/th>\nNo<\/td>\nObject<\/td>\nThe contact of the related party. The structure is explained elsewhere.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/h3>\n

Address Parameter details<\/h3>\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
label<\/th>\nText<\/td>\nYes<\/td>\nThe label of the address.<\/td>\n<\/tr>\n
country_code<\/th>\nText<\/td>\nYes<\/td>\nThe country code of the address (Example: “EG”).<\/td>\n<\/tr>\n
city<\/th>\nText<\/td>\nYes<\/td>\nThe name of the city in the specified country.<\/td>\n<\/tr>\n
address<\/th>\nText<\/td>\nNo<\/td>\nAdditional info of the address.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/h3>\n

Contact Parameter details<\/h3>\n\n\n\n\n\n\n\n
Parameter<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
type<\/th>\nText<\/td>\nYes<\/td>\nThe type of the contact provided. Possible values are: mobile<\/strong>, phone<\/strong>, email<\/strong>, fax<\/strong>, website<\/strong>, or other<\/strong>.<\/td>\n<\/tr>\n
label<\/th>\nText<\/td>\nYes<\/td>\nThe label of the contact.<\/td>\n<\/tr>\n
value<\/th>\nText<\/td>\nYes<\/td>\nThe value of the contact.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\u00a0<\/h3>\n

Responses<\/h4>\n\n\n\n\n\n\n\n\n\n
HTTP Status<\/th>\nresult<\/th>\ntitle<\/th>\nmessage<\/th>\nobject<\/th>\n<\/tr>\n<\/thead>\n
Success Responses<\/th>\n<\/tr>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nTransaction added successfully.<\/td>\n\n
{\n    \"transaction_id\": xxx,\n    \"transaction_serial\": \"YYY_ZZZZ\",\n    \"creation_date_time\": \"yyy-mm-dd hh:MM:ss\"\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
Failure Responses<\/th>\n<\/tr>\n
400 Bad Request<\/td>\nfalse<\/td>\nError<\/td>\nError message as elaborated here.<\/td>\n\n
{\n    \"error_code\": xxx\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
500 Internal Server Error<\/td>\nfalse<\/td>\nError<\/td>\nError message as elaborated here.<\/td>\n\n
{\n    \"error_code\": xxx\n}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 1<\/h4>\n\n\n\n\n
Request<\/th>\n\n
curl --request POST 'https:\/\/your_account.modulus.biz\/api\/csh\/v1\/Transaction=YOUR_TOKEN' \\\n  --header 'Content-Type: application\/json' \\\n  --data-raw '{\n    \"account_code\": \"1.6.2.5\",\n    \"account_exchange_rate\": 50,\n    \"date\": \"2024-01-01\",\n    \"cash_book_id\": 4,\n    \"amount\": 300,\n    \"transaction_type_code\": \"3\",\n    \"counter_party\": \"Customer\",\n    \"related_party\": {\n      \"code\": \"1\",\n      \"name\": \"Test name\",\n      \"type\": \"individual\",\n      \"account_code\": \"1.6.10.2\",\n      \"price_list_code\": \"1\",\n      \"tax_registration_number\": \"1\",\n      \"contact\": {\n        \"type\": \"mobile\",\n        \"label\": \"\u0627\u0644\u0642\u0627\u0647\u0631\u0629 \u0627\u0644\u062c\u062f\u064a\u062f\u0629\",\n        \"value\": \"0102224791\"\n      },\n      \"address\": {\n        \"label\": \"HEADOFFICE\",\n        \"country_code\": \"EG\",\n        \"city\": \"Alexandria\",\n        \"address\": \"Test Address\"\n      }\n    },\n    \"party_exchange_rate\": 20,\n    \"reference\": \"Test Reference\",\n    \"description\": \"Test Description\"\n  }'<\/code><\/pre>\n<\/td>\n<\/tr>\n
200 OK<\/th>\n\n
{\n    \"result\": true,\n    \"title\": \"Success\",\n    \"message\": \"Transaction added successfully\",\n    \"object\": {\n      \"transaction_id\": 631,\n      \"transaction_serial\": \"RCT-2024-0055\",\n      \"creation_date_time\": \"2024-05-01 13:48:43\"\n    }\n  }<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 2<\/h4>\n\n\n\n\n
Request<\/th>\n\n
curl --request POST 'https:\/\/your_account.modulus.biz\/api\/csh\/v1\/Transaction=YOUR_TOKEN' \\\n  --header 'Content-Type: application\/json' \\\n  --data-raw '{\n    \"account_code\": \"1.6.4.2\",\n    \"date\": \"2024-9-26\",\n    \"amount\": 1000.00,\n    \"cash_book_id\": 26,\n    \"counter_party\": \"Customer\",\n    \"transaction_type_code\": \"1\",\n    \"reference\": \"Test Reference\",\n    \"description\": \"Test Description\",\n    \"related_party\":{\n        \"code\":\"20\",\n        \"account_code\":\"1.6.10.2\",\n        \"price_list_code\":\"1\",\n        \"name\":\"Test Customer\",\n        \"tax_registration_number\":\"\",\n        \"type\": \"individual\",\n        \"contact\":{\n            \"type\": \"mobile\",\n            \"label\": \"\u0627\u0644\u0642\u0627\u0647\u0631\u0629 \u0627\u0644\u062c\u062f\u064a\u062f\u0629\",\n            \"value\": \"1\"\n        },\n        \"address\": {\n            \"label\": \"HEADOFFICE\",\n            \"country_code\": \"EG\", \n            \"city\": \"Alexandria\", \n            \"address\": \"Test Address\"\n        }\n    }\n  }'<\/code><\/pre>\n<\/td>\n<\/tr>\n
400 Bad Request<\/th>\n\n
{\n    \"result\": false,\n    \"title\": \"Error\",\n    \"message\": \"Invalid Currency\",\n    \"object\": {\n      \"error_code\": \"5609\"\n    }\n  }<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n
<\/p>\n","protected":false},"featured_media":0,"parent":4165,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4166"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=4166"}],"version-history":[{"count":17,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4166\/revisions"}],"predecessor-version":[{"id":4352,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4166\/revisions\/4352"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4165"}],"next":[{"title":"API: Update Transaction","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/cash-apis-v1\/api-update-transaction\/","href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4340"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=4166"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=4166"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}