id stringlengths 53 86 | api_name stringlengths 2 76 | api_description stringlengths 1 500 ⌀ | api_score float64 0 10 ⌀ | endpoint_name stringlengths 1 190 | endpoint_description stringlengths 0 500 | response_status_code int64 100 505 | response_summary stringlengths 1 68 ⌀ | response_json stringlengths 6 50k | response_json_schema stringlengths 14 150k |
|---|---|---|---|---|---|---|---|---|---|
99244b62-1c6d-4af9-9f92-62565407fab4/716e6ef9-82bb-40a7-986a-9896f3c0f3b3/1/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | DeleteTag | 401 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/716e6ef9-82bb-40a7-986a-9896f3c0f3b3/2/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | DeleteTag | 400 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/716e6ef9-82bb-40a7-986a-9896f3c0f3b3/3/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | DeleteTag | 400 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/84d02a18-d487-41e2-bc53-b713f2b9abf0/1/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | DownloadAuditLog | 403 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/84d02a18-d487-41e2-bc53-b713f2b9abf0/3/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | DownloadAuditLog | 401 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/84d02a18-d487-41e2-bc53-b713f2b9abf0/4/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | DownloadAuditLog | 403 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/84d02a18-d487-41e2-bc53-b713f2b9abf0/8/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | DownloadAuditLog | 401 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/d90bd9e4-4ee1-40ff-a599-d2a8e24e37f6/0/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | GetProperties | 401 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/d90bd9e4-4ee1-40ff-a599-d2a8e24e37f6/1/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | GetProperties | 200 | null | {"templateId": "", "title": "", "description": "", "documentTitle": "", "documentMessage": "", "files": [{"documentName": "", "order": 0, "pageCount": 0}], "roles": [{"name": "", "index": 0, "defaultSignerName": "", "defaultSignerEmail": "", "signerOrder": 0, "signerType": "Signer", "hostEmail": "", "hostName": "", "la... | {"title": "TemplateProperties", "type": "object", "properties": {"templateId": {"title": "String", "type": ["string", "null"]}, "title": {"title": "String", "type": ["string", "null"]}, "description": {"title": "String", "type": ["string", "null"]}, "documentTitle": {"title": "String", "type": ["string", "null"]}, "doc... | |
99244b62-1c6d-4af9-9f92-62565407fab4/d90bd9e4-4ee1-40ff-a599-d2a8e24e37f6/2/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | GetProperties | 403 | null | {"error": ""} | {"title": "ErrorResult", "type": "object", "properties": {"error": {"title": "String", "type": ["string", "null"]}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/4d107bd0-9ce3-4870-9f88-a87ae3c1a956/0/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | CreateEmbeddedTemplateUrl | 200 | null | {"templateId": "", "createUrl": ""} | {"title": "EmbeddedTemplateCreated", "type": "object", "properties": {"templateId": {"title": "String", "type": ["string", "null"]}, "createUrl": {"title": "Uri", "type": ["string", "null"], "format": "uri"}}, "additionalProperties": false} | |
99244b62-1c6d-4af9-9f92-62565407fab4/0c12ce5a-274a-4fae-8a5d-1fbe10ac2e45/0/0 | BoldSign | BoldSign offers a wide range of REST APIs that allow you to seamlessly integrate the complete sending and signing process within your applications. Learn more about BoldSign eSignature APIs. | null | getEmbeddedTemplateEditUrl | 200 | null | {"editUrl": ""} | {"title": "EmbeddedTemplateEdited", "type": "object", "properties": {"editUrl": {"title": "Uri", "type": ["string", "null"], "format": "uri"}}, "additionalProperties": false} | |
de790942-bf60-4b8c-bf62-ff7453e1fcc9/054b47ef-0f48-4b6e-bf8b-88e7680b97c0/0/0 | BIN INFO LOOKUP | Bank Identification Number (“BIN”) or Issuer identification number (“IIN”) is the first six digits of a bank card number or payment cards number | 0.2 | Bin lookup Pro | Provide the first 6-8 digits of a payment card number and get updated metadata such as country, type (debit or credit), segment (consumer or business) etc. | 200 | Example_1 | {"bin": "", "brand": "", "issuerCountry": "", "cardType": "", "cardCategory": "", "issuerBank": "", "cardNumberLengthList": [16], "cvvLengthList": [3]} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"bin": {"type": "string"}, "brand": {"type": "string"}, "issuerCountry": {"type": "string"}, "cardType": {"type": "string"}, "cardCategory": {"type": "string"}, "issuerBank": {"type": "string"}, "cardNumberLengthList": {"type": "array", "ite... |
c0cbe30f-a5c0-49dd-9742-9cfea85d2f38/1a55eb71-be48-465d-b381-481795649f07/0/0 | OptLog.co - Optimize Anything | OptLog is a software suite for a black-box global optimization engine for real-world metric optimization. The main advantage of OptLog is scalability, simplicity and continuity of serving. A function can be optimised at any time with any parameters without worrying about the optimizer state - OptLog does it for you! | 0 | optimize | The base endpoint for optimization | 201 | Example response from basic initialization | {"budget": 100, "experiment_id": "122455", "algorithm": "BASE", "direction": "MINIMIZE", "parameters": [{"name": "test_1", "type": "NUMBER", "minimum": 561, "maximum": 655, "initial": 610.9728}, {"name": "test_2", "type": "NUMBER", "minimum": 651, "maximum": 1518, "initial": 1034.7394}, {"name": "test_3", "type": "CHOI... | {"type": "object", "properties": {"budget": {"type": "integer"}, "experiment_id": {"type": "string"}, "algorithm": {"type": "string"}, "direction": {"type": "string"}, "parameters": {"type": "array", "items": {"type": "object"}}, "expiration_date": {"type": "string"}}} |
c0cbe30f-a5c0-49dd-9742-9cfea85d2f38/da1c3932-9eb4-4e71-9079-ed3693d064af/0/0 | OptLog.co - Optimize Anything | OptLog is a software suite for a black-box global optimization engine for real-world metric optimization. The main advantage of OptLog is scalability, simplicity and continuity of serving. A function can be optimised at any time with any parameters without worrying about the optimizer state - OptLog does it for you! | 0 | recommend | Recommend | 200 | New Example | {"budget": 99, "recommendation": ["{\"name\": \"test_1\", \"value\": 610.9728}", "{\"name\": \"test_2\", \"value\": 1034.7394}", "{\"name\": \"test_3\", \"value\": \"msh\"}", "{\"name\": \"test_4\", \"value\": \"mdbdygm\"}", "{\"name\": \"test_5\", \"value\": 3599.6425}", "{\"name\": \"test_6\", \"value\": 373.2653}"],... | {"type": "object", "properties": {"budget": {"type": "integer"}, "recommendation": {"type": "array", "items": {"type": "string"}}, "expiration_date": {"type": "string"}, "experiment_id": {"type": "string"}}} |
c0cbe30f-a5c0-49dd-9742-9cfea85d2f38/5f1ce990-5f83-4146-94ac-f4c7ec18e50c/0/0 | OptLog.co - Optimize Anything | OptLog is a software suite for a black-box global optimization engine for real-world metric optimization. The main advantage of OptLog is scalability, simplicity and continuity of serving. A function can be optimised at any time with any parameters without worrying about the optimizer state - OptLog does it for you! | 0 | optimize | get | 200 | New Example | {"budget": 100, "parameters": ["{\"name\": \"test_1\", \"value\": 610.9728}", "{\"name\": \"test_2\", \"value\": 1034.7394}", "{\"name\": \"test_3\", \"value\": \"msh\"}", "{\"name\": \"test_4\", \"value\": \"mdbdygm\"}", "{\"name\": \"test_5\", \"value\": 3599.6425}", "{\"name\": \"test_6\", \"value\": 373.2653}"], "e... | {"type": "object", "properties": {"budget": {"type": "integer"}, "parameters": {"type": "array", "items": {"type": "string"}}, "expiration_date": {"type": "string"}, "experiment_id": {"type": "string"}}} |
bd154989-03cb-4149-97f8-6646c200cd2d/2e1128f5-c82e-438a-ae86-72f9e68481cb/0/0 | TikTok Unauthorized API - Scraper, No-watermark, Analytics, Feed | reverse engineered TikTok mobile API covered non-autorized actions | 9.6 | Find user by sec_user_id, fetch profile info, fetch user posts | Endpoint does a sequence of actions under the hood:
fetches user stats (total likes, followers, subscriptions, etc.)
fetch "amount_of_posts" (passed as parameter) posts of this user (aweme_id, description, cover links). If value not passed or set as "0" then this action not executed.
| 200 | Example_1 | {"user": {"login_name": "", "name": "", "followers": 0, "following": 0, "likes": 0, "avatar": "", "sid": "", "secret": 0}, "posts": [{"cover": "", "animated_cover": "", "aweme_id": "", "description": ""}], "error": ""} | {"properties": {"user": {"properties": {"login_name": {"type": "string", "description": "Login name of user"}, "name": {"type": "string", "description": "Name of user"}, "followers": {"type": "integer", "description": "Amount of followers"}, "following": {"type": "integer", "description": "Amount of following"}, "likes... |
bd154989-03cb-4149-97f8-6646c200cd2d/c7a05177-0dc0-4cd7-aee9-0f0ffdfea0b5/0/0 | TikTok Unauthorized API - Scraper, No-watermark, Analytics, Feed | reverse engineered TikTok mobile API covered non-autorized actions | 9.6 | Build request to find post by link or aweme_id | Note: endpoints ending "_build_request" does NOT makes request to TikTok API but build http request (headers, body, request_urls). Using it you can build request yourself and execute it exactly as TikTok Mobile app does it within your own app. Should be used when you would like to fasten fetching data ( on all other en... | 200 | Example_1 | {"request": [{"method": "", "url": "", "headers": {}, "body": ""}]} | {"properties": {"request": {"type": "array", "items": {"required": ["body", "headers", "method", "url"], "properties": {"method": {"type": "string", "description": "Method of request"}, "url": {"type": "string", "description": "URL of request"}, "headers": {"type": "object", "description": "Headers of request", "additi... |
bd154989-03cb-4149-97f8-6646c200cd2d/19b2cd5d-2474-4d84-a36b-5fd57fd174cd/0/0 | TikTok Unauthorized API - Scraper, No-watermark, Analytics, Feed | reverse engineered TikTok mobile API covered non-autorized actions | 9.6 | Build request to find user's posts by sec_user_id | Note: endpoints ending "_build_request" does NOT makes request to TikTok API but build http request (headers, body, request_urls). Using it you can build request yourself and execute it exactly as TikTok Mobile app does it within your own app. Should be used when you would like to fasten fetching data ( on all other en... | 200 | Example_1 | {"request": [{"method": "", "url": "", "headers": {}, "body": ""}]} | {"properties": {"request": {"type": "array", "items": {"required": ["body", "headers", "method", "url"], "properties": {"method": {"type": "string", "description": "Method of request"}, "url": {"type": "string", "description": "URL of request"}, "headers": {"type": "object", "description": "Headers of request", "additi... |
bd154989-03cb-4149-97f8-6646c200cd2d/0da35e2c-bd9f-45d6-ac9f-6d55bc376d64/0/0 | TikTok Unauthorized API - Scraper, No-watermark, Analytics, Feed | reverse engineered TikTok mobile API covered non-autorized actions | 9.6 | Build request to find user and his info by sec_user_id | Note: endpoints ending "_build_request" does NOT makes request to TikTok API but build http request (headers, body, request_urls). Using it you can build request yourself and execute it exactly as TikTok Mobile app does it within your own app. Should be used when you would like to fasten fetching data ( on all other en... | 200 | Example_1 | {"request": [{"method": "", "url": "", "headers": {}, "body": ""}]} | {"properties": {"request": {"type": "array", "items": {"required": ["body", "headers", "method", "url"], "properties": {"method": {"type": "string", "description": "Method of request"}, "url": {"type": "string", "description": "URL of request"}, "headers": {"type": "object", "description": "Headers of request", "additi... |
bd154989-03cb-4149-97f8-6646c200cd2d/b293bc56-7aec-4e70-b9b0-01aff51c4374/0/0 | TikTok Unauthorized API - Scraper, No-watermark, Analytics, Feed | reverse engineered TikTok mobile API covered non-autorized actions | 9.6 | Find post by link or aweme_id. Fetch cover links, metrics, download links | Find post data (cover links, metrics, download links, etc.) by post identifier. Takes any of the following post identifiers:
- aweme_id
- share_link
- web_link
- short_link
If you mix up link type endpoint will work incorrectly! | 200 | Example_1 | {"posts": {"cover": "", "animated_cover": "", "aweme_id": "", "download_links": [], "play_links": [], "share_link": "", "web_link": "", "short_link": "", "comment_count": 0, "digg_count": 0, "download_count": 0, "forward_count": 0, "lose_comment_count": 0, "lose_count": 0, "play_count": 0, "share_count": 0, "whatsapp_s... | {"properties": {"posts": {"required": ["animated_cover", "aweme_id", "comment_count", "cover", "digg_count", "download_count", "download_links", "forward_count", "lose_comment_count", "lose_count", "play_count", "play_links", "share_count", "share_link", "short_link", "web_link", "whatsapp_share_count"], "properties": ... |
bd154989-03cb-4149-97f8-6646c200cd2d/fecae7fe-6f9a-4bd0-bfd5-188e29fb91a6/0/0 | TikTok Unauthorized API - Scraper, No-watermark, Analytics, Feed | reverse engineered TikTok mobile API covered non-autorized actions | 9.6 | Find liked posts by sec_user_id | Search for post user previously liked (only it the target user allowed this feature in privacy settings) | 200 | Example_1 | {"posts": [{"cover": "", "animated_cover": "", "aweme_id": "", "download_links": [], "play_links": [], "share_link": "", "web_link": "", "short_link": "", "comment_count": 0, "digg_count": 0, "download_count": 0, "forward_count": 0, "lose_comment_count": 0, "lose_count": 0, "play_count": 0, "share_count": 0, "whatsapp_... | {"properties": {"posts": {"type": "array", "items": {"required": ["animated_cover", "aweme_id", "comment_count", "cover", "digg_count", "download_count", "download_links", "forward_count", "lose_comment_count", "lose_count", "play_count", "play_links", "share_count", "share_link", "short_link", "web_link", "whatsapp_sh... |
5088372a-4e42-4fe5-baed-05e476e08e72/7cd1eecc-f96a-40a9-bbd0-7b13814023ec/2/0 | hello 123 | hello 123 | null | getOrderById | For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions | 200 | null | {"id": 0, "petId": 0, "quantity": 0, "shipDate": "", "status": "placed", "complete": true} | {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "petId": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "quantity": {"type": "integer", "format": "int32", "minimum":... |
5088372a-4e42-4fe5-baed-05e476e08e72/d603373d-0e93-41f1-a7ec-a80a1a9589de/1/0 | hello 123 | hello 123 | null | getUserByName | 200 | null | {"id": 0, "username": "", "firstName": "", "lastName": "", "email": "", "password": "", "phone": "", "userStatus": 0} | {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "username": {"type": "string"}, "firstName": {"type": "string"}, "lastName": {"type": "string"}, "email": {"type": "string"}, "password": {"type": "string"}, "phone": {"type":... | |
5088372a-4e42-4fe5-baed-05e476e08e72/dab3909f-ef4f-4220-9b1e-2e9f1f43b29a/2/0 | hello 123 | hello 123 | null | getPetById | Returns a single pet | 200 | null | {"id": 0, "category": {"id": 0, "name": ""}, "name": "doggie", "photoUrls": [], "tags": [{"id": 0, "name": ""}], "status": "available"} | {"type": "object", "required": ["name", "photoUrls"], "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "category": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 92233... |
5088372a-4e42-4fe5-baed-05e476e08e72/a0672cab-cffc-4a40-b76d-5316ea436111/1/0 | hello 123 | hello 123 | null | findPetsByStatus | Multiple status values can be provided with comma separated strings | 200 | null | [{"id": 0, "category": {"id": 0, "name": ""}, "name": "doggie", "photoUrls": [], "tags": [{"id": 0, "name": ""}], "status": "available"}] | {"type": "array", "items": {"type": "object", "required": ["name", "photoUrls"], "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "category": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036... |
5088372a-4e42-4fe5-baed-05e476e08e72/99e2d69b-566e-47fc-8698-0d030f679592/1/0 | hello 123 | hello 123 | null | findPetsByTags | Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. | 200 | null | [{"id": 0, "category": {"id": 0, "name": ""}, "name": "doggie", "photoUrls": [], "tags": [{"id": 0, "name": ""}], "status": "available"}] | {"type": "array", "items": {"type": "object", "required": ["name", "photoUrls"], "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "category": {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036... |
5088372a-4e42-4fe5-baed-05e476e08e72/d98a891e-fdb3-4f15-a2ef-0f77f36c2705/2/0 | hello 123 | hello 123 | null | placeOrder | 200 | null | {"id": 0, "petId": 0, "quantity": 0, "shipDate": "", "status": "placed", "complete": true} | {"type": "object", "properties": {"id": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "petId": {"type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "quantity": {"type": "integer", "format": "int32", "minimum":... | |
5088372a-4e42-4fe5-baed-05e476e08e72/3b5cc56a-ddb9-4cc7-a298-cadfd210c420/0/0 | hello 123 | hello 123 | null | uploadFile | 200 | null | {"code": 0, "type": "", "message": ""} | {"type": "object", "properties": {"code": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "type": {"type": "string"}, "message": {"type": "string"}}} | |
4261c182-2df6-4d0b-ab6b-51dad366d0a2/1a42bba4-a588-4c33-9c35-29ad8a8dcc70/1/0 | HexaEight SSO Platform | Implement Authentication as well as Encryption at Application Layer in any Desktop, Mobile and Web Assembly Apps using our Suite Of Authentication APIs | 7.5 | get-sharedkey-forclientapp | HexaEight Token Issuer uses this endpoint to Fetch an asymmetric shared key for the Client App based on the Client ID for authorized users and resources. | 200 | New Example | {"key1": "value", "key2": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]} |
4261c182-2df6-4d0b-ab6b-51dad366d0a2/e610d414-5d2d-47b5-bc0d-c956ccbc4216/0/0 | HexaEight SSO Platform | Implement Authentication as well as Encryption at Application Layer in any Desktop, Mobile and Web Assembly Apps using our Suite Of Authentication APIs | 7.5 | get-new-securetoken | Use This EndPoint to Fetch a SecureToken for your Client Application. This Secure token should be used in the Client Application along with the code challenge for enhanced security of the Client Application. | 200 | New Example | {"key1": "value", "key2": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]} |
3907f31a-6b96-4fb5-b22b-a7f3d95d1ba7/bbce4a49-ba92-4da9-b0c9-28188888b0c2/0/0 | QR Code and Bar Code Functions | Discover the power and versatility of QRCode and Bar Code with Logo, our comprehensive API for generating and decoding QR codes with ease. Our user-friendly documentation covers a wide range of functionalities, from creating custom QR codes and Bar Code with adjustable sizes, colors, and styles to decoding existing cod... | null | QRCodeDecode | Decode the given QR Code | 200 | Response | {"data": "http://eepurl.com/lLDUb"} | {"type": "object", "properties": {"url": {"type": "string"}}} |
3907f31a-6b96-4fb5-b22b-a7f3d95d1ba7/744683f5-a95c-42ba-8e0c-1f1b09f6af02/0/0 | QR Code and Bar Code Functions | Discover the power and versatility of QRCode and Bar Code with Logo, our comprehensive API for generating and decoding QR codes with ease. Our user-friendly documentation covers a wide range of functionalities, from creating custom QR codes and Bar Code with adjustable sizes, colors, and styles to decoding existing cod... | null | BarcodeDecode | Decode Barcode | 200 | Response | {"code": "701197205291"} | {"type": "object", "properties": {"code": {"type": "string"}}} |
3907f31a-6b96-4fb5-b22b-a7f3d95d1ba7/0e50bcaf-aa94-43dc-b376-72fd80d52d3f/0/0 | QR Code and Bar Code Functions | Discover the power and versatility of QRCode and Bar Code with Logo, our comprehensive API for generating and decoding QR codes with ease. Our user-friendly documentation covers a wide range of functionalities, from creating custom QR codes and Bar Code with adjustable sizes, colors, and styles to decoding existing cod... | null | BarcodeToPNG | Generate your BarCode | 200 | Response | {"url": "https://files.1saas.co/3ebc6376d55267d35053e54433cdf2910812df82/barcode-k9GNRbMXi9.png"} | {"type": "object", "properties": {"data": {"type": "string"}, "options": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"type": "integer"}, "text": {"type": "string"}, "textAlign": {"type": "string"}}}, "format": {"type": "string"}, "getAsUrl": {"type": "boolean"}}} |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/eb2aa0d9-68fe-428d-83a0-fc74c9a76e92/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get user following list | get user following list | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.3387, "data": {"followings": [{"id": "6735163239137985542", "region": "US", "sec_uid": "MS4wLjABAAAAhRXcIEYagScezXqLSjmmtSRETrrbvvv0z-2vwE7lYBEeqOZRUrMjDWOr9gEu2cEt", "unique_id": "danisvibin", "nickname": "danisvibin", "signature": "Pretty much an influencer at this po... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"followings": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "reg... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/e439a0f0-beaa-42f1-99de-0e4201164c15/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get tiktok video info | Get tiktok video full info. HD Quality, No Watermark. Fast.
Support Tiktok & Douyin.
Support Getting Image List.
Support Tiktok Stories. | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.4491, "data": {"aweme_id": "v12044gd0000cafum43c77u65l2kj0jg", "id": "7106658991907802411", "region": "US", "title": "which biome style are you? \ud83d\udef6\ud83d\udc20\ud83d\udd6f\ud83c\udfd4 #Minecraft", "cover": "https://p19-sign.tiktokcdn-us.com/obj/tos-useast5-p-0... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"aweme_id": {"type": "string"}, "id": {"type": "string"}, "region": {"type": "string"}, "title": {"type":... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/b8fb1da0-d8ba-4c3e-ada9-e795cfb83567/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get tiktok video info (title do not appear #) | The # interface will not appear in the header
Get tiktok video full info. HD Quality, No Watermark. Fast.
Support Tiktok & Douyin.
Support Getting Image List.
Support Tiktok Stories. | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.3616, "data": {"aweme_id": "v12044gd0000cafum43c77u65l2kj0jg", "id": "7106658991907802411", "region": "US", "title": "which biome style are you? \ud83d\udef6\ud83d\udc20\ud83d\udd6f\ud83c\udfd4", "cover": "https://p16-sign.tiktokcdn-us.com/obj/tos-useast5-p-0068-tx/4f94... | {"type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"aweme_id": {"type": "string"}, "id": {"type": "string"}, "region": {"type": "string"}, "title": {"type": "string"}, "cover": {"type": "string"}, "ori... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/297de579-cc75-4682-a572-c39fa8f01bb4/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get challenge post videos | get challenge post videos | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.543, "data": {"videos": [{"aweme_id": "v12044gd0000chfvtk3c77ubs37jcqvg", "video_id": "7232779684935781678", "region": "US", "title": "Replying to @mcpotluck should i? \ud83d\ude3c #zelda #legendofzelda #foryou #fyp\u30b7 #cosplay ", "cover": "https://p16-sign.tiktokcdn... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"videos": {"type": "array", "items": {"type": "object", "properties": {"aweme_id": {"type": "string"}, "v... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/8f6b11b7-560f-439f-b31d-995d13cd4b9c/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get comment list by video | get comment list by video | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.3171, "data": {"comments": [{"id": "7093322092531893035", "text": "Tik tok u ban my main and YOU DON'T BAN A VIDEO THAT A GIRL GIVES BIRTH YOU DON'T BAN HEAT YOU DON'T BAN ABUSE IM SICK OF IT WHAT DID I DO", "create_time": 1651542755, "digg_count": 81, "reply_total": 17... | {"type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "text": {"type": "string"}, "create_time": {"type":... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/b56361cc-a5a9-4552-9495-8a06d28560e7/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get reply list by comment id | get reply list by comment id | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.2169, "data": {"comments": [{"id": "7093851779850568490", "text": "DUDE SAME", "create_time": 1651666090, "digg_count": 1, "user": {"id": "7073234161172268074", "region": "US", "sec_uid": "MS4wLjABAAAAbLBre_8ZWbVBL5FYTE5P7GnAPciiwG5xp9oNm1Fzr4fjdoO3MbHytV8r9H83t_PX", "u... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"comments": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "string"}, "text"... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/a1818b84-237b-40ef-bef7-fac2539e6f71/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get region list | get region list | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.0006, "data": {"PG": "Papua New Cuinea", "NA": "Namibia", "PL": "Poland", "UG": "Uganda", "GH": "Ghana", "BL": "St. Barth\u00e9lemy", "SO": "Somali", "CG": "Congo - Brazzaville", "MM": "Myanmar (Burma)", "BZ": "Belize", "AL": "Albania", "IS": "Iceland", "LC": "St.Lucia"... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"PG": {"type": "string"}, "NA": {"type": "string"}, "PL": {"type": "string"}, "UG": {"type": "string"}, "... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/792c0956-ef58-4de2-9086-3071f8cccba8/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get feed video list by region | get feed video list by region | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 2.4633, "data": [{"aweme_id": "v10025g50000ci0r80jc77u3kmi6b2ag", "video_id": "7242267608920149250", "region": "JP", "title": "\u30a6\u30af\u30e9\u30a4\u30ca\u5175\u2026\u3084\u3063\u305f\u306e\u304b.. \u5f71\u6b66\u8005\u3068\u304b\u6016\u3044\u308f\ud83d\ude42#\u30a6\u3... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "array", "items": {"type": "object", "properties": {"aweme_id": {"type": "string"}, "video_id": {"type": "string"}, "region": {"ty... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/23a7e448-8bb3-478d-84db-663e1d7f1ba6/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | search video list by keywords | search video list by keywords | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.818, "data": {"videos": [{"aweme_id": "v10044g50000ch8f71rc77u0flms5rm0", "video_id": "7228545269598604552", "region": "JP", "title": "\u6700\u8fd1\u307e\u305f\u6d41\u884c\u3063\u3066\u3066\u5b09\u3057\u3044\ud83e\udd7a\ud83e\udef6\u3076\u304d\u307f\u3086\u3061\u30fc\u3... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"videos": {"type": "array", "items": {"type": "object", "properties": {"aweme_id": {"type": "string"}, "v... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/1fea3b29-db5d-426d-98d0-2b6f97648969/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | search user | get user list by keywords | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 1.2564, "data": {"user_list": [{"user": {"id": "107955", "uniqueId": "tiktok", "nickname": "TikTok", "avatarThumb": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/1971e99be0d67160f34f39fb1d66a0e5~c5_100x100.jpeg?biz_tag=musically_user.user_cover&x-expires=16858800... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"user_list": {"type": "array", "items": {"type": "object", "properties": {"user": {"type": "object", "pro... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/29eac1e6-fbd9-4f05-9ce6-1d2f25d8e677/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | user follower list | get user follower list | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.3056, "data": {"aweme_id": "v12044gd0000cafum43c77u65l2kj0jg", "id": "7106658991907802411", "region": "US", "title": "which biome style are you? \ud83d\udef6\ud83d\udc20\ud83d\udd6f\ud83c\udfd4 #Minecraft", "cover": "https://p16-sign.tiktokcdn-us.com/obj/tos-useast5-p-0... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"aweme_id": {"type": "string"}, "id": {"type": "string"}, "region": {"type": "string"}, "title": {"type":... |
edf2610d-a22e-4b36-b131-d4f6bedd4b32/8ef5b929-9f19-4161-b3a5-9850db151ccd/0/0 | tiktok download video | Tiktok Best Spider. Fast. HD Quality. Without Watermark Download. Video Full Detail. Signature X-Argus,X-Ladon,X-Gorgon
mail: nb429429@gmail.com | 9.9 | get user info | get user info
unique_id or user_id is not empty | 200 | New Example | {"code": 0, "msg": "success", "processed_time": 0.3056, "data": {"aweme_id": "v12044gd0000cafum43c77u65l2kj0jg", "id": "7106658991907802411", "region": "US", "title": "which biome style are you? \ud83d\udef6\ud83d\udc20\ud83d\udd6f\ud83c\udfd4 #Minecraft", "cover": "https://p16-sign.tiktokcdn-us.com/obj/tos-useast5-p-0... | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "msg": {"type": "string"}, "processed_time": {"type": "number"}, "data": {"type": "object", "properties": {"aweme_id": {"type": "string"}, "id": {"type": "string"}, "region": {"type": "string"}, "title": {"type":... |
ecd82867-04d6-4715-8311-7bbc5a9805e9/92a3dbc2-5b64-475c-b79f-6d724147065e/0/0 | IP2Location | IP to Country api with country code & their currency name & currency code | null | IP to Country | IP to Country just perform GET request with ip parameter | 200 | Response | {"ip": "190.2.145.41", "country": "Netherlands", "countryCode": "NL", "CurrencyName": "Euro", "CurrencyCode": "EUR"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"ip": {"type": "string"}, "country": {"type": "string"}, "countryCode": {"type": "string"}, "CurrencyName": {"type": "string"}, "CurrencyCode": {"type": "string"}}, "required": ["CurrencyCode", "CurrencyName", "country", "countryCode", "ip"]... |
a3fa193b-2e4d-40f2-9eec-7903681283ba/a70638bc-3f47-4c0d-9a53-02b0d9c4eca9/0/0 | Hydrogen | The simplest signing method for iOS apps. | null | Main Uploading and Signing API | This endpoint uploads and signs your file. | 200 | New Example | {"status": 200, "response": "There was a problem processing your request"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "integer"}, "response": {"type": "string"}}, "required": ["response", "status"]} |
097a2e82-45bd-46ac-b5a4-2286d91c706e/f7479fc6-3786-41aa-9803-69655623a9c0/0/0 | Web Renderer | Web Renderer provides cloud API to create PDF or render image from web pages or raw HTML documents. | 7.4 | GetRenderingTaskStatus | Returns current status of rendering job. | 200 | New Example | {"key1": "value", "key2": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]} |
097a2e82-45bd-46ac-b5a4-2286d91c706e/bea22a7e-5de5-42c4-8f35-d0079fe807bb/0/0 | Web Renderer | Web Renderer provides cloud API to create PDF or render image from web pages or raw HTML documents. | 7.4 | DownloadResult | Downloads rendered file from server. | 200 | New Example | {"key1": "value", "key2": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]} |
c0b4de05-7d12-4dd4-8e1e-fa2923855d80/603e1c7c-64a7-4036-a538-007bedb4e6fd/0/0 | Email Verify | Fast & Accurate Email Verification and Find with Real Time Fresh Results.
Get Datapoints such as Deliverable, Valid Email Syntax, Disposable Email, Inbox Full & More. | 7 | Find Email | It will find the email address of any Person by using the Name & Company Website. Get genuine Emails that are 100% verified with details like disposable, deliverable, full-inbox & catch-all. | 200 | New Example | {"valid_format": true, "deliverable": true, "full_inbox": false, "host_exists": true, "catch_all": false, "disposable": false, "message": "You can send messages to this Email ID", "email": "michaelgustus@rapidapi.com", "domain": "rapidapi.com"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"valid_format": {"type": "boolean"}, "deliverable": {"type": "boolean"}, "full_inbox": {"type": "boolean"}, "host_exists": {"type": "boolean"}, "catch_all": {"type": "boolean"}, "disposable": {"type": "boolean"}, "message": {"type": "string"... |
c0b4de05-7d12-4dd4-8e1e-fa2923855d80/13072cb3-a65c-49a8-acf9-6273bb90ad5f/0/0 | Email Verify | Fast & Accurate Email Verification and Find with Real Time Fresh Results.
Get Datapoints such as Deliverable, Valid Email Syntax, Disposable Email, Inbox Full & More. | 7 | Verify Email | Verify Email will check for the following: If the email is working and deliverable If the email address exists If the email is a disposable email If the email inbox is full or not If the email has a correct syntax | 200 | New Example | {"valid_format": true, "deliverable": true, "full_inbox": false, "host_exists": true, "catch_all": false, "disposable": false, "message": "You can send messages to this Email ID", "email": "support@rapidapi.com", "domain": "rapidapi.com"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"valid_format": {"type": "boolean"}, "deliverable": {"type": "boolean"}, "full_inbox": {"type": "boolean"}, "host_exists": {"type": "boolean"}, "catch_all": {"type": "boolean"}, "disposable": {"type": "boolean"}, "message": {"type": "string"... |
196e35f0-9cdf-4333-9389-e973e369abce/e32353f7-d15b-4311-9a53-179794ba2f0d/0/0 | PreflightAPI | PreflightAPI allows the automation of printing preflight process for web-2-print services, websites and in internal checking automation tools | null | /Analyze/{units}/{maxpages}/{lang}/ | Method return preflight results. We do not make any fixes or changes in source file | 200 | null | [{"fields": ["Framed PDF", "Fixed PDF", "LowResImages", "File size", "Preflight effect", "Preflight status", "Page", "Operation Type", "Pages", "PreflightID", "Domain", "PreflightInfo", "PreflightWarnings", "PreflightErrors", "CorrectTrimBox", "EmbeddedFonts", "NotEmbeddedFonts", "LowResImagesList"]}, {"data": [["", "3... | {"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"fields": {"type": "array", "items": {"type": "string"}}, "data": {"type": "array", "items": {"type": "array", "items": {"type": ["integer", "string"]}}}}}} |
196e35f0-9cdf-4333-9389-e973e369abce/d58b70d7-5e4b-4acf-924a-079483f53418/0/0 | PreflightAPI | PreflightAPI allows the automation of printing preflight process for web-2-print services, websites and in internal checking automation tools | null | /Refine/{units}/{maxpages}/{bleeds}/{lang}/{aprofile}/{addpage}/{overprint}/ | PreflightAPI base method | 200 | null | [{"fields": ["Framed PDF", "Fixed PDF", "Preview", "File size", "Preflight effect", "Preflight status", "Page", "Operation Type", "Pages", "PreflightID", "Domain", "PreflightInfo", "PreflightWarnings", "PreflightErrors", "CorrectTrimBox"]}, {"data": [["https://preflightapi.s3.eu-central-1.amazonaws.com/642068d71bd17d60... | {"type": "string"} |
0a1ec37b-4baa-4c78-96f0-f984a34b38e6/46bdae48-4421-4498-b93c-ce0be533a941/0/0 | Invoices Generator | Effortlessly create professional PDF invoices in record time using our user-friendly API. | 8 | Generate Invoice | Quickly generate invoices through a REST API endpoint | 200 | New Example | {"success": true, "url": "PDF_URL"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"success": {"type": "boolean"}, "url": {"type": "string"}}, "required": ["success", "url"]} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/bb7b6c3a-1ab4-4d1d-b2d0-04b188963044/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | prepareClosingTransactions | Prepares the Transactions for translating foreign Currency denominated Account balances to the reporting Currency saving them to the database (unposted).
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| reporting_period_id | required, integer | Must exist |
| forex_account_id | required, integer | ... | 400 | null | {"status": "error", "errors": {"forex_account_id": ["Translation Forex Account must be of Type Equity "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/bb7b6c3a-1ab4-4d1d-b2d0-04b188963044/0/1 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | prepareClosingTransactions | Prepares the Transactions for translating foreign Currency denominated Account balances to the reporting Currency saving them to the database (unposted).
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| reporting_period_id | required, integer | Must exist |
| forex_account_id | required, integer | ... | 400 | null | {"status": "error", "errors": {"status": ["Reporting Period must have Adjusting status to translate foreign balances"]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/bb7b6c3a-1ab4-4d1d-b2d0-04b188963044/0/2 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | prepareClosingTransactions | Prepares the Transactions for translating foreign Currency denominated Account balances to the reporting Currency saving them to the database (unposted).
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| reporting_period_id | required, integer | Must exist |
| forex_account_id | required, integer | ... | 400 | null | {"status": "error", "errors": {"id": ["Closing Rate for PEN is missing "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/bb7b6c3a-1ab4-4d1d-b2d0-04b188963044/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | prepareClosingTransactions | Prepares the Transactions for translating foreign Currency denominated Account balances to the reporting Currency saving them to the database (unposted).
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| reporting_period_id | required, integer | Must exist |
| forex_account_id | required, integer | ... | 200 | null | {"status": "success", "closing_transactions": [{"credited": true, "transaction_type": "JN", "transaction_date": "2022-12-31T00:00:00.000000Z", "account_id": 2, "narration": "BND 2022 Forex Balance Translation", "reference": "BND", "currency_id": 1, "transaction_no": "JN02/0001", "exchange_rate_id": 4, "entity_id": 1, "... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/9776f95b-de0e-4a2c-920b-d182cea33c3b/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | transactionCurrencies | Retrieves a list of foreign Currencies used in transactions during the Reporting period.
Optional Query Parameters:
| Parameter | Attributes | Notes |
| --- | --- | --- |
| acccount-id | optional, integer | Filters the returned currencies to those used in transactions for the given account. Account with the given Id mu... | 200 | null | {"status": "success", "transaction_currencies": [{"currency_id": 2, "currency_code": "RON"}, {"currency_id": 5, "currency_code": "CVE"}]} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/ed96d7e9-21c2-4237-ac73-500cfac2eb75/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | updateEntity | Updates the Entity represented by the given Id.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| currency_code | required, string, length:3 | |
| multi_currency | optional, boolean | Defaults to false |
| year_start | optional, numeric, minimum:1, maximum:12 | Defaul... | 200 | null | {"status": "success", "message": "Entity: Acme Inc Updated updated successfully", "resource": {"uuid": "5fb00ee4-b651-4c04-bd3a-832aa36704d4", "id": 2, "user_id": 1, "currency_id": 3, "name": "Acme Inc Updated", "multi_currency": true, "mid_year_balances": true, "year_start": 1, "locale": "en_GB", "current_reporting_pe... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/71e3cb5c-f5f6-4728-ac0e-c9a2122a10bc/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteBalance | Deletes the Balance represented by the given Id. | 200 | null | {"status": "success", "message": "Credit Balance: Barrett Runolfsdottir DVM for year 2008 deleted successfully"} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/30e6720a-9083-4127-afde-c3f7abc54522/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteExchangeRate | Deletes the Exchange Rate represented by the given Id. | 400 | null | {"status": "error", "errors": {"exchange_rate_id": ["ExchangeRate cannot be deleted because it has Balances: (1) depending on it "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/30e6720a-9083-4127-afde-c3f7abc54522/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteExchangeRate | Deletes the Exchange Rate represented by the given Id. | 200 | null | {"status": "success", "message": "ExchangeRate: 1.00 for Betsy Steuber (ZMW) from 2022-10-21 deleted successfully"} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/6511f587-903b-4b29-838a-ea10a19679a6/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | updateDiscount | Updates the Discount represented by the given Id.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| code | required, string, minimum:1, maximum:5 | |
| rate | required, numeric, minimum:1 | |
| account_id | required, integer | Must exist |
| entity_id | optional, i... | 200 | null | {"status": "success", "message": "Discount: Trade Discount Updated (DC) at 15.00% updated successfully", "resource": {"uuid": "7419aff2-7a43-4d30-856d-33380aba0020", "id": 2, "entity_id": 1, "account_id": 1, "code": "DC", "name": "Trade Discount Updated", "rate": 15, "gross_discount": false, "operations_discount": fals... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/ead37b16-ed5d-4aca-b1cd-af56eb6c0d19/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | openingBalances | Retrieves the totals of the outstanding amounts in Balance Sheet Accounts from previous Reporting Periods.
Query Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| year | optional, integer | The year whose Balances to retrieve | | 200 | null | {"status": "success", "balances": {"balances": {"debit": 90, "credit": -90}, "accounts": [{"uuid": "d686186b-e2a4-4780-892a-d9d400e53f61", "id": 1, "entity_id": 1, "category_id": null, "currency_id": 1, "code": 6, "name": "Violette Howell", "description": null, "opening_balance": 70, "type": "Receivable", "is_closed": ... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/6e44e8da-8760-42b0-91fd-c80a3e6b4da2/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getDiscount | Retrieves the Discount with the passed in Id. | 200 | null | {"status": "success", "resource": {"uuid": "e3e1863a-933f-4796-975f-ae5aa4f1ace4", "id": 1, "entity_id": 1, "account_id": 1, "code": "BCEDA", "name": "Prof. Riley White", "rate": "3.0000", "gross_discount": true, "operations_discount": false, "account": {"uuid": "9bf98392-556e-4f68-8e92-3fcfef689f25", "id": 1, "entity_... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c197fd4e-e215-4431-99fe-8074885d14b7/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteTax | Deletes the Tax represented by the given Id. | 400 | null | {"status": "error", "errors": {"line_item": ["Tax cannot be deleted because it has Line Items: (1) depending on it "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/c197fd4e-e215-4431-99fe-8074885d14b7/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteTax | Deletes the Tax represented by the given Id. | 200 | null | {"status": "success", "message": "Tax: Input Vat (VAT) at 5.00% deleted successfully"} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/ab9efac0-a7be-449f-9e67-b8643a208e2e/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteCurrency | Deletes the Currency represented by the given Id. | 200 | null | {"status": "success", "message": "Currency: Uganda Shillings (UGX) deleted successfully"} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/ab9efac0-a7be-449f-9e67-b8643a208e2e/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteCurrency | Deletes the Currency represented by the given Id. | 400 | null | {"status": "error", "errors": {"currency_id": ["Currency cannot be deleted because it has Exchange Rates: (1), Accounts: (2) depending on it "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/e7e92c75-a730-48cc-a2d2-45e1dacf60ed/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getTaxes | Retrieves a paginated list of Taxes associated with the logged-in user. | 200 | null | {"current_page": 1, "data": [{"uuid": "98f4136a-0ad8-4090-9a68-b4d4ff969779", "id": 1, "entity_id": 1, "account_id": 1, "code": "DBEAC", "name": "Sydni Strosin", "rate": "7.0000", "withholding_tax": false, "account_type": ["CONTROL"], "account": {"uuid": "9f1e37b9-7ccf-4292-aa64-b205eab9a37f", "id": 1, "entity_id": 1, ... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/a29ccaa2-0860-4d92-b2a8-eb7e1074c885/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getBalance | Retrieves the Balance with the passed in Id. | 200 | null | {"status": "success", "resource": {"uuid": "07157c6e-3ea8-4d23-a88c-39e4dfc0bd40", "id": 1, "entity_id": 1, "account_id": 1, "currency_id": 2, "exchange_rate_id": 1, "reporting_period_id": 2, "reference": null, "transaction_date": "2021-10-21 00:00:00", "transaction_no": "1EGP2008", "balance_type": "DEBIT", "balance": ... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/24ec6049-ce98-44e1-aae5-b7ad61550cb6/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | postClosingTransactions | StartFragment
Posts the Transactions for translating foreign Currency denominated Account balances to the reporting Currency to the ledger.
EndFragment
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| reporting_period_id | required, integer | Must exist | | 200 | null | {"status": "success", "message": "Closing Transactions posted successfully"} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/7c62c83c-2b3c-46d8-bb3e-cf7b3f191761/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getEntity | Retrieves the Entity with the passed in Id. | 200 | null | {"status": "success", "resource": {"uuid": "0ba1490e-57e3-4bdb-ac78-2127ffb6e482", "id": 1, "user_id": 1, "currency_id": 1, "name": "Gleichner-Upton", "multi_currency": false, "mid_year_balances": false, "year_start": 1, "locale": "en_GB", "current_reporting_period": {"uuid": "2d25c94a-db3b-4d44-b497-9ee41a36f26d", "id... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/4a32a8eb-7b37-428d-afa0-59eec1c4be0d/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | updateCurrency | Updates the Currency represented by the given Id.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| currency_code | required, string, length:3, unique | |
| name | optional, string | Defaults to the Currency's ISO name | | 200 | null | {"status": "success", "message": "Currency: Uganda Shillings (UGX) updated successfully", "resource": {"uuid": "f9780c14-6aac-4fe8-b9d9-ff54e7ca67a9", "id": 8, "user_id": 1, "name": "Uganda Shillings", "currency_code": "UGX"}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/30ae24c3-0e42-4504-abd5-3598fc9a9041/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | createTax | Creates a Tax.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| code | required, string, minimum:1, maximum:5 | |
| rate | required, numeric, minimum:0 | |
| account_id | required, integer | Must exist, only required if the rate > 0 |
| entity_id | optional, integer... | 400 | null | {"status": "error", "errors": {"account_id": ["Tax Account Type must be one of: Control "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/30ae24c3-0e42-4504-abd5-3598fc9a9041/0/1 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | createTax | Creates a Tax.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| code | required, string, minimum:1, maximum:5 | |
| rate | required, numeric, minimum:0 | |
| account_id | required, integer | Must exist, only required if the rate > 0 |
| entity_id | optional, integer... | 400 | null | {"status": "error", "errors": {"account_id": ["10% Tax requires a Tax Account "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/30ae24c3-0e42-4504-abd5-3598fc9a9041/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | createTax | Creates a Tax.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| code | required, string, minimum:1, maximum:5 | |
| rate | required, numeric, minimum:0 | |
| account_id | required, integer | Must exist, only required if the rate > 0 |
| entity_id | optional, integer... | 200 | null | {"status": "success", "message": "Tax: Output Vat (VAT) at 10.00% created successfully", "resource": {"name": "Output Vat", "code": "VAT", "rate": 10, "account_id": 1, "entity_id": 1, "id": 2, "account_type": ["CONTROL"], "account": {"uuid": "9f1e37b9-7ccf-4292-aa64-b205eab9a37f", "id": 1, "entity_id": 1, "category_id"... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/618cd2e0-97f3-4b1f-a21e-569a67de0a0c/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | createEntity | Creates an Entity.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| currency_code | required, string, length:3 | |
| multi_currency | optional, boolean | Defaults to false |
| year_start | optional, numeric, minimum:1, maximum:12 | Defaults to 1 (January) |
| mid_yea... | 200 | null | {"status": "success", "message": "Entity: Acme Inc created successfully", "resource": {"name": "Acme Inc", "locale": "en_GB", "user_id": 1, "id": 2, "currency_id": 3, "current_reporting_period": {"calendar_year": "2022", "period_count": 3, "status": "OPEN", "entity_id": 1, "id": 3}, "currency": {"currency_code": "USD",... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/618cd2e0-97f3-4b1f-a21e-569a67de0a0c/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | createEntity | Creates an Entity.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| currency_code | required, string, length:3 | |
| multi_currency | optional, boolean | Defaults to false |
| year_start | optional, numeric, minimum:1, maximum:12 | Defaults to 1 (January) |
| mid_yea... | 400 | null | {"status": "error", "errors": {"locale": ["Locale en_US is not configured"]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/7bd98ec8-fc34-4dcb-b84f-c5a94f95b3f0/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | createCurrency | Creates a currency.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| currency_code | required, string, length:3, unique | |
| name | optional, string | Defaults to the Currency's ISO name | | 200 | null | {"status": "success", "message": "Currency: Kenyan Shilling (KES) created successfully", "resource": {"name": "Kenyan Shilling", "currency_code": "KES", "user_id": 1, "id": 8}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/16b3676a-6db8-45a1-9ea6-20e12767fae6/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | updateExchangeRate | Updates the Exchange Rate represented by the given Id.
Parameters:
| Parameters | Attributes |
| --- | --- |
| currency_id | required, integer |
| rate | required, numeric |
| valid_from | required, date |
| valid_to | optional, date | | 200 | null | {"status": "success", "message": "ExchangeRate: 105.00 for Ashly Bergstrom (AWG) from 2022-10-07 updated successfully", "resource": {"uuid": "826a0ac1-39e3-4452-9291-49d99f332dcb", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-07T22:22:57.000000Z", "valid_to": "2022-10-20T05:33:28.000000Z", "rate": ... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/94df4432-854a-423a-91e9-23c48392f083/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getCurrency | Retrieves the Currency with the passed in Id. | 200 | null | {"status": "success", "resource": {"uuid": "f6837745-1657-4b19-9f85-ec680b26e487", "id": 1, "user_id": 1, "name": "Justine Breitenberg", "currency_code": "MDL"}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/95f5eec6-046b-44b1-9a52-8806b3348c0e/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getTax | Retrieves the Tax with the passed in Id. | 200 | null | {"status": "success", "resource": {"uuid": "98f4136a-0ad8-4090-9a68-b4d4ff969779", "id": 1, "entity_id": 1, "account_id": 1, "code": "DBEAC", "name": "Sydni Strosin", "rate": "7.0000", "withholding_tax": false, "account_type": ["CONTROL"], "account": {"uuid": "9f1e37b9-7ccf-4292-aa64-b205eab9a37f", "id": 1, "entity_id"... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/0507ff12-3342-40cb-bbb3-9ae060245abb/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | updateTax | Updates the Tax represented by the given Id.
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| name | required, string | |
| code | required, string, minimum:1, maximum:5 | |
| rate | required, numeric, minimum:0 | |
| account_id | required, integer | Must exist, only required if the rate > 0 |
|... | 200 | null | {"status": "success", "message": "Tax: Input Vat (VAT) at 5.00% updated successfully", "resource": {"uuid": "b75f2e69-3063-4b8d-abb9-2b73b116db7d", "id": 2, "entity_id": 1, "account_id": 1, "code": "VAT", "name": "Input Vat", "rate": 5, "withholding_tax": false, "account_type": ["CONTROL"], "account": {"uuid": "9f1e37b... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/727cefc3-3858-4e68-9d2f-81ef38653650/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getExchangeRate | Retrieves the Exchange Rate with the passed in Id. | 200 | null | {"status": "success", "resource": {"uuid": "826a0ac1-39e3-4452-9291-49d99f332dcb", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-07T22:22:57.000000Z", "valid_to": "2022-10-20T05:33:28.000000Z", "rate": "1.7563"}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/704dc2e1-0230-408a-b2d9-5d1b62143382/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getReportingPeriods | Retrieves a paginated list of Reporting Periods associated with the logged in user. | 200 | null | {"current_page": 1, "data": [{"uuid": "4ccd37f4-3070-4470-8ef3-3c2babc69f52", "id": 1, "entity_id": 1, "period_count": 5, "status": "OPEN", "calendar_year": 2022, "closing_date": null}, {"uuid": "c561e65a-5fe7-4eb8-af32-453ced06191a", "id": 2, "entity_id": 1, "period_count": 8, "status": "OPEN", "calendar_year": 1978, ... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/27bf5c5a-7598-4465-9d33-e508108d2445/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteReportingPeriod | Deletes the Reporting Period represented by the given Id. | 200 | null | {"status": "success", "message": "ReportingPeriod: 2023 deleted successfully"} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/27bf5c5a-7598-4465-9d33-e508108d2445/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteReportingPeriod | Deletes the Reporting Period represented by the given Id. | 400 | null | {"status": "error", "errors": {"reporting_period_id": ["ReportingPeriod cannot be deleted because it has Closing Rates: (1), Closing Transactions: (1) depending on it "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/b967fd82-3506-45cb-a230-01c9a24970c3/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | createReportingPeriod | Creates a Reporting Period. (Note: creating an Entity also creates a default Reporting Period for it for the current calendar year).
Parameters:
| Parameters | Attributes | Notes |
| --- | --- | --- |
| calendar_year | required, integer | |
| period_count | required, integer | The number of years the Entity has been i... | 200 | null | {"status": "success", "message": "ReportingPeriod: 2023 created successfully", "resource": {"status": "OPEN", "calendar_year": 2023, "period_count": 2, "entity_id": 1, "id": 3}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/b622a215-a6c1-4f29-9e73-f7797a112a1c/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getCurrencies | Retrieves a paginated list of Currencies associated with the logged-in user. | 200 | null | {"current_page": 1, "data": [{"uuid": "f6837745-1657-4b19-9f85-ec680b26e487", "id": 1, "user_id": 1, "name": "Justine Breitenberg", "currency_code": "MDL"}, {"uuid": "915711f6-2332-4040-8237-cef00ed04ace", "id": 2, "user_id": 1, "name": "Dr. Florine Aufderhar", "currency_code": "RSD"}, {"uuid": "fc009911-50a6-4c33-ade8... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/faf594b0-a485-4263-801d-139f306e4159/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getClosingRates | Retrieves the Closing Rates belonging to the Currency with the passed in Id.
Query Parameters:
| Parameter | Attributes | Notes |
| --- | --- | --- |
| year | optional, integer | The year to Closing Rates for | | 200 | null | {"status": "success", "closing_rates": [{"uuid": "a0a4a1ca-511a-4562-b04e-585be74b46f0", "id": 1, "entity_id": 1, "exchange_rate": {"id": 1, "rate": "1.7563"}, "reporting_period": {"id": 2, "calendar_year": 2022}}, {"uuid": "b91b15cb-926c-4e32-8847-a629fbcaf2f5", "id": 2, "entity_id": 1, "exchange_rate": {"id": 2, "rat... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/edf59c2a-84ba-44a0-83b9-af75f1e44f41/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getExchangeRates | Retrieves the Exchange Rates belonging to the Currency with the passed in Id.
Optional Query Parameters:
| Parameter | Attributes | Notes |
| --- | --- | --- |
| start-date | optional, date | The earliest validity of the Exchange Rates to retrieve |
| end-date | optional, date | The latest validity of the Exchange Rate... | 200 | null | {"status": "success", "exchange_rates": [{"uuid": "414a48cd-2115-40bb-a8f6-bda0d4a67bf0", "id": 1, "entity_id": 1, "currency_id": 2, "valid_from": "2022-10-14T23:47:19.000000Z", "valid_to": "2022-10-20T05:29:50.000000Z", "rate": "1.1603"}, {"uuid": "3d371951-28c8-410c-a6a7-7af4d6418b76", "id": 2, "entity_id": 1, "curre... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/77739da1-6260-4422-987c-8529f35d821e/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getEntities | Retrieves a paginated list of Entities associated with the logged-in user. | 200 | null | {"current_page": 1, "data": [{"uuid": "0ba1490e-57e3-4bdb-ac78-2127ffb6e482", "id": 1, "user_id": 1, "currency_id": 1, "name": "Gleichner-Upton", "multi_currency": false, "mid_year_balances": false, "year_start": 1, "locale": "en_GB", "current_reporting_period": {"uuid": "2d25c94a-db3b-4d44-b497-9ee41a36f26d", "id": 1,... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/ccfa9122-d153-41ff-855a-280a3e6d5ef3/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | listClosingTransactions | Lists the Closing Transactions for the given Reporting Period.
Optional Query Parameters:
| Parameter | Attributes | Notes |
| --- | --- | --- |
| acccount-id | optional, integer | Filters the closing transactions to those entered for the given account. Account with the given Id must exist. | | 200 | null | {"status": "success", "closing_transactions": {"Breanne Connelly II": [{"currency": "EGP", "closing_rate": "100.0000", "currency_balance": -100, "local_balance": -11000, "foreign_balance": -10000, "translation": -1000, "posted": false}, {"currency": "PYG", "closing_rate": "100.0000", "currency_balance": -100, "local_ba... | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/88cce32c-4b5a-4c2f-bbc6-c6f13bdafcbc/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteDiscount | Deletes the Discount represented by the given Id. | 200 | null | {"status": "success", "message": "Discount: Trade Discount Updated (DC) at 15.00% deleted successfully"} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/88cce32c-4b5a-4c2f-bbc6-c6f13bdafcbc/1/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteDiscount | Deletes the Discount represented by the given Id. | 400 | null | {"status": "error", "errors": {"line_item": ["Discount cannot be deleted because it has Line Items: (1) depending on it "]}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/71ccdd53-6ccb-47ca-ba16-afcdc035b17c/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | getReportingPeriod | Retrieves the Reporting Period with the passed in Id. | 200 | null | {"status": "success", "resource": {"uuid": "4ccd37f4-3070-4470-8ef3-3c2babc69f52", "id": 1, "entity_id": 1, "period_count": 5, "status": "OPEN", "calendar_year": 2022, "closing_date": null}} | {"type": "object"} |
6988cefe-3cc8-4c08-a77d-c2ee157cd571/930d209d-8e55-4680-9321-e8eb1fa3a022/0/0 | Microbooks | An IFRS compliant Accounting API that caters to all financial reporting needs. | 5.1 | deleteEntity | Deletes the Entity represented by the given Id. | 200 | null | {"status": "success", "message": "Entity: Acme Inc Updated deleted successfully"} | {"type": "object"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.