{"info":{"_postman_id":"f5147f8a-759b-44c1-afb4-c7da368a6152","name":"POS Connect","description":"

POS Connect API ( v 1.1 )

This service enables you to transfer daily Point of sale (POS) transactions to Helix System.

Our APIs includes the following:

Authentication - An endpoint to establish secure connection between our client and our server

Invoice Sending - An endpoint to bridge client invoices from Point of sale (POS) to the Helix system

Invoice Checking - An endpoint to view Point of sale data transmitted to Helix system

The API can be access via the URL : https://app.helixcas.com/posconnect

Update History:

v 1.0 ( 07/12/2023 ) - Initial Deployment of API
v 1.1 ( 08/03/2023) - Update documentations

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"POS Connect API ( v 1.1 )","slug":"pos-connect-api-v-11"}],"owner":"1237913","collectionId":"f5147f8a-759b-44c1-afb4-c7da368a6152","publishedId":"2s9XxwwEHF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-03T08:22:38.000Z"},"item":[{"name":"Authenticate","id":"4e901cb3-bc75-4131-bbcf-37c0f1a025a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyid","value":"viamare","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": \"krQ98KUAQKLAdMgTHNWYUxl28ldFc9GnPtcotKnpm7N60RUKJoTYAqUE6Z0LyL8fiwJUxsVdzqNh0FkZ4ZBnFlpdP/SP4KEF1Lypw6AGwzqVCXOcJxmediIEttGRbUEmOr8YKbynsBWLO3GAbB6IQ3N2qbolqR8UvTWsmPzi2nIpKpxKeGYHa42rt1xoirqN0pTyv1HtcatKN/NMWOcxGvbSDZmMG2RrSw30CGgJ8jLiE/b1NWlVr7g8quwI7nMFfduuGgQznPLLRmVHk5hpZxI5NyFJkmnAG5qWEJxSZoXLsK4/GZyVrnKGv1YSJ/dMcca1kIxjR8LcbfTQNo+gWQ==\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{url}/resources/auth","description":"

An endpoint to establish secure connection between our client and our server

Note:

An RSA encryption is required to generate a Token

To create a token request:

Include the header: companyid to the request
\n
Encrypt the JSON Object with the following format:
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
companyid	An Identifier provided by Helix CAS
username	Email address registered to Helix CAS
password	Password to access Helix CAS

Sample Format:

{\"companyid\":\"1\",\"username\":\"sample@email.com\",\"password\":\"sample_password\"}

Note:

The public key to encrypt the JSON Object will be provided upon request

A token response will be provided once authentication is successful. The token can be used to transact to the API within 6 hours of issuance.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"f5147f8a-759b-44c1-afb4-c7da368a6152","id":"f5147f8a-759b-44c1-afb4-c7da368a6152","name":"POS Connect","type":"collection"}},"urlObject":{"path":["resources","auth"],"host":["{url}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e901cb3-bc75-4131-bbcf-37c0f1a025a1"},{"name":"Send POS Invoice","id":"00e3bcae-b110-4a17-a141-08e21788a801","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"6ACE50F6E831D554485DA813428CB174E3DB7C3F01967EC1F50BFDFE967314EDE0892ABF4D0986FAFA12A4C14CE9D0861ADD86DDFDD2A49EA9C0E6FA7D2D7E5A237319D19B66152A1DA8CB87680C21F717CDEDFB2B6B5320E435B0DCCF92616B","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{url}/resources/v1/posreport","description":"

An endpoint to bridge client invoices from POS to the Helix System

Include in the header: token generated from authentication process
\n
The expected JSON data should be in a JSON array format
\n
The following information composes the JSON Header data:
\n

\n\n

The following information composes the JSON details for LineItems:

\n\n

If submission is successful, a transmit_id will be provided. You can use the transmittal id to check the status of submission

Note:

A token is required to submit request

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"f5147f8a-759b-44c1-afb4-c7da368a6152","id":"f5147f8a-759b-44c1-afb4-c7da368a6152","name":"POS Connect","type":"collection"}},"urlObject":{"path":["resources","v1","posreport"],"host":["{url}"],"query":[],"variable":[]}},"response":[],"_postman_id":"00e3bcae-b110-4a17-a141-08e21788a801"},{"name":"Check POS Summary via ID","id":"c8998156-149f-43b0-9a95-8e5215d1689d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"6ACE50F6E831D554485DA813428CB174E3DB7C3F01967EC1F50BFDFE967314EDE0892ABF4D0986FAFA12A4C14CE9D0861ADD86DDFDD2A49EA9C0E6FA7D2D7E5A237319D19B66152A1DA8CB87680C21F717CDEDFB2B6B5320E435B0DCCF92616B","type":"text"}],"url":"{url}/resources/v1/posreport/{transmit_id}","description":"

An endpoint to review the status of the submitted invoices

The following information is required:

transmit_id : transmittal id returned after a successful sending of invoice

Returns:

TotalSale - Total sales amount
TransactionCount - Transaction count
StartingInvoice - Starting invoice number
EndingInvoice - Ending invoice number
Terminal - Terminal number
BranchID - Branch number

Note:

A token is required to submit request

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"f5147f8a-759b-44c1-afb4-c7da368a6152","id":"f5147f8a-759b-44c1-afb4-c7da368a6152","name":"POS Connect","type":"collection"}},"urlObject":{"path":["resources","v1","posreport","{transmit_id}"],"host":["{url}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8998156-149f-43b0-9a95-8e5215d1689d"}],"auth":{"type":"bearer","bearer":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"3df6cac4-636e-473f-9dad-2a8c3755af53","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e2b67d06-aa4c-44d1-b4fd-d18f3987a42c","type":"text/javascript","exec":[""]}}]}