The objective of the integration is to allow POS merchants to synchronize their daily sales data to Codemax RMS for inventory tracking purpose. The submitted invoices will be processed by the API server, and RMS inventory movement will be updated accordingly.
\nA total of three APIs are involved in this integration, and Bearer authentication scheme is used as the HTTP framework for access control and authentication. The first API is the Authentication API, which returns a set of access and refresh tokens after the login credentials are validated and authenticated successfully. The access token returned will be used as the Bearer token to call the second API, the Sync Invoices API. This token is valid for only 15 minutes. Once it expires, you will need to call the third API, the Refresh Authentication API, by submitting both the expired access token and refresh token to retrieve a new set of access and refresh tokens.
\nPlease be informed that a maximum of 20 invoices can be synced per request. If more than 20 invoices are pending for synchronization, you will need to make sure that your application is able to loop and sync up to 20 invoices at a time. Table below is the list of response codes for your reference.
\nStaging URL: https://possync-staging.c-mx.co
\nLive URL : https://possync.c-mx.co
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6771787","collectionId":"74783d53-4c4a-4bef-9cab-823ae88fee87","publishedId":"2sAXqv3fhi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-09-23T10:29:37.000Z"},"item":[{"name":"Authentication","id":"ddeb9ef0-44b9-4eab-8aae-18e355738381","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"loginId\" : \"posuser002@codemax.my\",\r\n \"password\" : \"pos321!\",\r\n \"branchCode\" : \"B001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/auth","description":"This API returns you a set of access and refresh tokens. Please get the \"loginId\", \"password\", and \"branchCode\" from Codemax.
\n","urlObject":{"protocol":"https","path":["api","v1","user","auth"],"host":["codemax-posintegration-staging","azurewebsites","net"],"query":[],"variable":[]}},"response":[{"id":"c88318db-520e-413c-b98a-784739f6e16e","name":"With valid credentials","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"loginId\" : \"posuser002@codemax.my\",\r\n \"password\" : \"pos321!\",\r\n \"branchCode\" : \"B001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 14 Feb 2025 03:37:35 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImcxTFhtLzlKL01pNlNoMXEweFd3cjRKZ0g4dytTWER5cXBiWERIckFXbEdJZXpOL2RsWFFSTXpKQkpSaUQrTlRTNFpsa09KT0xQZ1NnRTJTcTVPUUNMbUFBNzJMZ09pdnFxcng1Z1gvaVNrPSIsIm5iZiI6MTczOTUwNDI1NSwiZXhwIjoxNzM5NTA1MTU1LCJpYXQiOjE3Mzk1MDQyNTV9.kC42ax-nw02tBKJxuixQAamALS0pmqQMwrvAAVtBpU0\",\n \"refreshToken\": \"dc840a14-bf4f-400b-929e-39e86d804b47\"\n}"},{"id":"87eeb4bd-6e1d-4de3-bd9d-ad5606d0659c","name":"With invalid loginId","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"loginId\" : \"xpossynctest1@codemax.my\",\r\n \"password\" : \"123456\",\r\n \"branchCode\" : \"B001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/auth"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 20 Sep 2024 04:04:16 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid login ID.\"\n}"},{"id":"355a9af1-1e51-48cd-89a9-e2a743944ed6","name":"With invalid password","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"loginId\" : \"posuser002@codemax.my\",\r\n \"password\" : \"123456x\",\r\n \"branchCode\" : \"B001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/auth"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 16 Dec 2024 08:52:33 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid password.\"\n}"},{"id":"7c4bbd6a-5316-4aef-8da7-293c479c996e","name":"With invalid branchCode","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"loginId\" : \"posuser002@codemax.my\",\r\n \"password\" : \"pos321!\",\r\n \"branchCode\" : \"B001x\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/auth"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 16 Dec 2024 08:53:30 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid branch code.\"\n}"},{"id":"fce3a1d3-e292-43aa-9f56-c66bd2d94914","name":"Authentication","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"loginId\" : \"posuser001@codemax.my\",\r\n \"password\" : \"pos123!\",\r\n \"branchCode\" : \"B001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Tue, 05 Nov 2024 15:04:10 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IlprQ29PUXdMQldtZ3R5YlBkL1NhN21BYmlyNnEyZG81UHJaQTBGL0NPQ1czNTlkMGNIV2k5bk1Ma3NlOVFNYlBlQm5JTFZ6S05HMHpab0JMMFZZRmhpaC95MkRNOG8yRXF1UktNM1gvQ3pVPSIsIm5iZiI6MTczMDgxOTA1MCwiZXhwIjoxNzMwODE5OTUwLCJpYXQiOjE3MzA4MTkwNTB9.PhHd8NXpcqN5XEdtlCEYe57BElQFs9Ve4kGnC528W5A\",\n \"refreshToken\": \"312af8ce-402d-4ea0-9b42-e25b9e594a05\"\n}"}],"_postman_id":"ddeb9ef0-44b9-4eab-8aae-18e355738381"},{"name":"Sync Invoices","id":"c75b8cc2-bec7-4bcd-95c5-830dd599a837","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6Im41K1BiaTB0QUpSNW8yMmxPVnVUWmltbVZRdkFWeEo0a0VJbGFxdjc1TFJRNkRDd1Y2czRzL0RBSEZOYXAzRXQxbUROdno4QXgzTTJRTW8rbWNrOUpIcGFTNlRscjRtRUhVejJPZlR5NEhVPSIsIm5iZiI6MTcyNzA3MzQxMCwiZXhwIjoxNzI3MDc0MzEwLCJpYXQiOjE3MjcwNzM0MTB9.Xzz3rbj9IUqFeFjXGNDV9-hCrPnBWZKUUBPkAZHiM6M","description":"Access token
\n","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"invoiceNo\": \"INV001\",\r\n \"refNo\": \"INV001_REF\",\r\n \"invoiceStatus\": \"NEW\",\r\n \"tableNo\": \"TABLE01\",\r\n \"pax\": \"1\",\r\n \"invoiceCreatedDate\": \"2025-03-24 15:10:33\",\r\n \"invoicePaymentDate\": \"2025-03-24 15:10:33\",\r\n \"invoiceDiscountName\": \"\",\r\n \"invoiceDiscountAmount\": 0,\r\n \"invoiceDiscountType\": 0,\r\n \"invoiceDiscountValue\": 0,\r\n \"roundingAdj\": 0,\r\n \"grandTotal\": 12.80,\r\n \"taxDetails\": [\r\n {\r\n \"taxCode\": \"SC\",\r\n \"taxName\": \"Service Charge 10%\",\r\n \"taxAmount\": 0,\r\n \"taxPercentage\": 0\r\n },\r\n {\r\n \"taxCode\": \"SST\",\r\n \"taxName\": \"SST 6%\",\r\n \"taxAmount\": 0,\r\n \"taxPercentage\": 0\r\n }\r\n ],\r\n \"invoiceItems\": [\r\n {\r\n \"itemParentCode\": \"P-FG002\",\r\n \"itemCode\": \"FG002\",\r\n \"itemName\": \"SPAGHETTI CARBONARA\",\r\n \"quantity\": 1,\r\n \"uom\": \"unit\",\r\n \"unitPrice\": 13.50,\r\n \"totalPrice\": 27.00,\r\n \"discountAmount\": 0,\r\n \"discountType\": 0,\r\n \"discountValue\": 0,\r\n \"unitNetPrice\": 13.50,\r\n \"totalNetPrice\": 27.00,\r\n \"orderDate\": \"2025-03-24 15:10:33\",\r\n \"orderLine\": 1,\r\n \"lineMode\": 0,\r\n \"taxDetails\": [\r\n {\r\n \"taxCode\": \"SC\",\r\n \"taxName\": \"Service Charge 10%\",\r\n \"taxAmount\": 0,\r\n \"taxPercentage\": 0\r\n },\r\n {\r\n \"taxCode\": \"SST\",\r\n \"taxName\": \"SST 6%\",\r\n \"taxAmount\": 0,\r\n \"taxPercentage\": 0\r\n }\r\n ],\r\n \"invoiceModifiers\": []\r\n }\r\n ],\r\n \"invoicePayments\": [\r\n {\r\n \"paymentCode\": \"P001\",\r\n \"paymentName\": \"CASH\",\r\n \"AmountPaid\": 27.00\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/sync/invoices","description":"To sync invoices to Codemax, call this API using the access token retrived from the Authentication API. Please note that a maximum of 20 invoices can be synced per request. If the response code returned is 701, 703, 704, or 705, your access token is invalid
\nIf the response code returned from Sync Invoices API is 702, call this API by submitting both the existing access and refresh tokens. Upon validation, a new set of access and refresh tokens will be returned. If the submitted refresh token does not match with server's record, a response code of 706 will be returned ,and you will need to call Authentication API to obtain a new set of access and refresh token by using the provided login credentials.
\n","urlObject":{"protocol":"https","path":["api","v1","user","refreshauth"],"host":["codemax-posintegration-staging","azurewebsites","net"],"query":[],"variable":[]}},"response":[{"id":"e238f779-1bae-49ca-8d3f-bf6d8051ab70","name":"With valid tokens","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6Im41K1BiaTB0QUpSNW8yMmxPVnVUWmltbVZRdkFWeEo0a0VJbGFxdjc1TFJRNkRDd1Y2czRzL0RBSEZOYXAzRXQxbUROdno4QXgzTTJRTW8rbWNrOUpIcGFTNlRscjRtRUhVejJPZlR5NEhVPSIsIm5iZiI6MTcyNjgwNTMxNSwiZXhwIjoxNzI2ODA2MjE1LCJpYXQiOjE3MjY4MDUzMTV9.D7kVayKCiduwSV1YO7WIftL3z_9QilYglkbzag1VO4Y\",\r\n \"refreshToken\": \"df6008be-3893-4022-96f5-e7f48abea8d3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/refreshauth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 20 Sep 2024 04:08:51 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6Im41K1BiaTB0QUpSNW8yMmxPVnVUWmltbVZRdkFWeEo0a0VJbGFxdjc1TFJRNkRDd1Y2czRzL0RBSEZOYXAzRXQxbUROdno4QXgzTTJRTW8rbWNrOUpIcGFTNlRscjRtRUhVejJPZlR5NEhVPSIsIm5iZiI6MTcyNjgwNTMzMiwiZXhwIjoxNzI2ODA2MjMyLCJpYXQiOjE3MjY4MDUzMzJ9.6F8CPpUrLkaMBgzhZjj-Xe14RSZy7yOr7CegXVoQvpM\",\n \"refreshToken\": \"15582bb8-6ae3-4083-af3a-9ae74a304643\"\n}"},{"id":"4981fd21-cd0e-4542-98d0-6629cad508fc","name":"With Invalid Access Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6Im41K1BiaTB0QUpSNW8yMmxPVnVUWmltbVZRdkFWeEo0a0VJbGFxdjc1TFJRNkRDd1Y2czRzL0RBSEZOYXAzRXQxbUROdno4QXgzTTJRTW8rbWNrOUpIcGFTNlRscjRtRUhVejJPZlR5NEhVPSIsIm5iZiI6MTcyNjc1NTgxOSwiZXhwIjoxNzI2NzU2NzE5LCJpYXQiOjE3MjY3NTU4MTl9.OJv8t7LubTnoX4GkQrsSOnT31dRjPdMLmCH9H27ZWSs\",\r\n \"refreshToken\": \"40cfc9e9-421b-4e84-91dd-cd0320aa3077\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/refreshauth"},"code":701,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 23 Sep 2024 08:49:58 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Set-Cookie","value":"ARRAffinity=1dad761c57dbf38e357e256e5c10cada67a95bb99dad8edcf8a2b89bf8df75fa;Path=/;HttpOnly;Secure;Domain=codemax-posintegration-staging.azurewebsites.net"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=1dad761c57dbf38e357e256e5c10cada67a95bb99dad8edcf8a2b89bf8df75fa;Path=/;HttpOnly;SameSite=None;Secure;Domain=codemax-posintegration-staging.azurewebsites.net"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Access token does not match with server record.\"\n}"},{"id":"36e455c6-1dcc-432c-89e9-e0c29262eb28","name":"With Invalid Refresh Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"accessToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6Im41K1BiaTB0QUpSNW8yMmxPVnVUWmltbVZRdkFWeEo0a0VJbGFxdjc1TFJRNkRDd1Y2czRzL0RBSEZOYXAzRXQxbUROdno4QXgzTTJRTW8rbWNrOUpIcGFTNlRscjRtRUhVejJPZlR5NEhVPSIsIm5iZiI6MTcyNzA3MzQxMCwiZXhwIjoxNzI3MDc0MzEwLCJpYXQiOjE3MjcwNzM0MTB9.Xzz3rbj9IUqFeFjXGNDV9-hCrPnBWZKUUBPkAZHiM6M\",\r\n \"refreshToken\": \"40cfc9e9-421b-4e84-91dd-cd0320aa3077\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://codemax-posintegration-staging.azurewebsites.net/api/v1/user/refreshauth"},"code":706,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 23 Sep 2024 08:53:11 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refresh token does not match with server record.\"\n}"}],"_postman_id":"a2ae818a-3cd7-4fcd-bff3-fc81e65c583e"}]}