{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b09943fa-d758-4b96-a299-3855e45f5064","name":"api@akaun","description":"# akaun.com API Documentation\n\nakaun.com is the next generation enterprise cloud native platform for businesses to take advantage of cloud native architecture.\nThis API documentation provide the specifications of all API calls to the akaun.com back-end RESTful services.\nThe information in this website is the intellectual property of BigLedger Private Limited (Singapore). Terms and conditions apply.\n\nFor inquiry, you may email to vincent@wavelet.net\n\n# Overview\n\n1. You need a valid Authentication token, and Tenant code to send requests to the API endpoints. To get your Authentication token, and Tenant code kindly Email vincent@wavelet.net.\n\n2. Response to every request is sent in JSON format. \n\n3. The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something akaun,  `POST` implies you want to save something new to akaun, 'PUT' to update the existing object, and 'DELETE' to remove the object. Please refer to the operation description for details on the exact type of effect it has.\n\n4. For `POST`, `PUT`, and `DELETE` operations, you need to provide `appId` to be included in the header. Every applet in bigledger should have an `AppId`, and when posting messages  to the back-end api.akaun.com, it is needed to know which `appId` is posting those messages, and whether they have the permission to do so.\nwhen pulling the records / information from the database, only `appId` with permissions can read certain records granted by the user / administrator of a tenant. \n\n5. The API calls will respond with appropriate HTTP status codes for all requests. A `200 OK` indicates all went well, while `4XX` or `5XX` response codes indicate an error from the requesting client or our API servers respectively.\n\n6. Individual resources in your akaun Account is accessible using its unique id (`guid`). The `guid` is global unique identifier that uniquely specifies the resource. \n\n7. Currently Akaun APIs accept requests and send responses with time information as UTC time zone. It is up to the developer to handle conversion as  required. \n\n\n# Response   \n\nYou will receive the response in the following json format   \n{  \n`\"code\":\"RESPONSE CODE\",`  \n`\"data\":\"RESPONSE DATA\",`  \n`\"message\":\"RESPONSE MESSAGE\"`    \n}   \n`code` : is the response code, that explains the nature of the response.  \n`data` : is the actual data to be fetched from akaun. It will be `null` if no records are found.  \n`message` : is some extra information about the response.  \n\n# Response code  \nHere are  codes you might receive as `code` in the  json response object  \n\n| Code                  | Meaning   |\n|-----------------------|----------------|\n| `CLIENT_AUTH_NOTOKEN`       | Authentication Error, check the value of your token  |\n| `OK_RESPONSE`     | Successful response |\n| `BAD_REQUEST`         | Un-successful request, some required fields are missing  |  \n| `SERVER_GENERAL_UNKNOWNERROR`         | Internal server error  |  \n\n\n# FAQ  \n\n**Authentication Questions**   \n**Q1** How do I get the Authentication token  \n**A1** You need to sign up for bigledger account. Once your email is verified, refer to  https://api-docs.akaun.com/?version=latest#16b20fa1-e183-4262-8cce-c2b7d79bcfa9 to get your token.  \n\n**Q2** How do I get the tenant code  \n**A2** If your are intersted in integration with akaun, please contact vincent@wavelet.net  \n\n**Integration Questions**   \n**Q1** Why DELETE and GET methods don't have body.  \n**A1** Akaun APIs follow restful standards, DELETE and GET are not expected to have body. To use them, append the guid of the object you want to perform the opertion on to the url (e.g. http://api-sandbox.akaun.com/api/v1/aging-periods/{guid}).\n\n**Q2** How do I get the guid of an object.  \n**A2** You can use \"Get by Criteria\" endpoint, where you can add more parameters to specifiy the object.\n\n**Q3** I am facing a problem, where do I get help    \n**A3** Please create ticket at https://wavelet.atlassian.net/servicedesk/customer/portal/8  \n\n**Q4** I would like to suggest certain feature to be added.    \n**A4** For suggestions please create ticket at https://wavelet.atlassian.net/servicedesk/customer/portal/8\n\nThanks","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1962664","team":99058,"collectionId":"b09943fa-d758-4b96-a299-3855e45f5064","publishedId":"RVtvrDav","public":true,"publicUrl":"https://api-docs.akaun.com","privateUrl":"https://go.postman.co/documentation/1962664-b09943fa-d758-4b96-a299-3855e45f5064","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2019-12-05T06:29:08.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e03d625ef194f0c69fca4296c6877611016c4406157db9be54d4465512fa57df","favicon":"https://akaun.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.akaun.com/view/metadata/RVtvrDav"}