{ "opencollection": "1.0.0", "info": { "name": "Cube Agents Currencies API", "version": "1.0.0 (1.0)" }, "items": [ { "info": { "name": "Currencies", "type": "folder" }, "items": [ { "info": { "name": "List a company's enabled currencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/company", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all of the currencies enabled by a company" }, { "info": { "name": "Bulk update the company's currencies", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cubesoftware.com/currencies/company/bulk_update", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes all related currencies to the company, and replaces the list with the provided payload" }, { "info": { "name": "List currency conversion rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/rates", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "from_currency", "value": "", "type": "query", "description": "The ID of the currency the rate converts from" }, { "name": "limit", "value": "", "type": "query", "description": "The number of results to return" }, { "name": "offset", "value": "", "type": "query", "description": "An offset for the results for pagination" }, { "name": "order_by", "value": "", "type": "query", "description": "A way to order the rates by date" }, { "name": "rateable_id", "value": "", "type": "query", "description": "The ID of the \"rateable\" object associated with the rate" }, { "name": "rateable_type", "value": "", "type": "query", "description": "The content type ID of the model class of the \"rateable\" object" }, { "name": "to_currency", "value": "", "type": "query", "description": "The ID of the currency the rate converts to" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List currency conversion rates" }, { "info": { "name": "Create a currency conversion rates", "type": "http" }, "http": { "method": "POST", "url": "https://api.cubesoftware.com/currencies/rates", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a currency conversion rates" }, { "info": { "name": "Retrieve a currency conversion rate by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/rates/:id", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this conversion rate." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve a currency conversion rate by ID" }, { "info": { "name": "Completely update a currency conversion rate by ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cubesoftware.com/currencies/rates/:id", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this conversion rate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Completely update a currency conversion rate by ID" }, { "info": { "name": "Update specific fields within a currency conversion rate by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cubesoftware.com/currencies/rates/:id", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this conversion rate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update specific fields within a currency conversion rate by ID" }, { "info": { "name": "Delete a currency conversion rate by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cubesoftware.com/currencies/rates/:id", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this conversion rate." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a currency conversion rate by ID" }, { "info": { "name": "Lock's a ConversionRate from being editable.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cubesoftware.com/currencies/rates/:id/lock", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this conversion rate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint identifies the specific ConversionRate and updates the is_locked attribute to True.\n This will make it not editable." }, { "info": { "name": "UnLock's a ConversionRate from being not editable.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cubesoftware.com/currencies/rates/:id/unlock", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this conversion rate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint identifies the specific ConversionRate and updates the is_locked attribute to False.\n This will make it editable." }, { "info": { "name": "Bulk Update Currency Conversion Rates", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cubesoftware.com/currencies/rates/bulk_update", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint allows for a destructive delete all and bulk create Currency Conversion Rates for\n a specific rateable object. This is meant to be used with DimensionExchangeRateTypeMapping entities as the\n rateable." }, { "info": { "name": "List all dimension conversion rate mappings", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/rates/dimension-mappings", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "is_default", "value": "", "type": "query", "description": "Whether or not to only get default rates" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all dimension conversion rate mappings" }, { "info": { "name": "Create dimension conversion rate mapping", "type": "http" }, "http": { "method": "POST", "url": "https://api.cubesoftware.com/currencies/rates/dimension-mappings", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new dimension conversion rate mapping. This object creation may trigger the deletion of other existing mappings if the new object's fields would cause a conflict with those mappings. Will result in a response of 409 (Conflict), and require an additional query parameter `confirm=true` in the request to proceed with creating the mapping and deleting the existing mappings that conflict.Clients that receive a 200 OK response for an create should subsequently request the mappings list to lea" }, { "info": { "name": "Update dimension conversion rate mapping", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cubesoftware.com/currencies/rates/dimension-mappings/:id", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing dimension conversion rate mapping. An update may trigger the deletion of other existing mappings if the updated fields would cause a conflict with those mappings. Clients that receive a 200 OK response for an update should subsequently request the mappings list to learn of any deletions." }, { "info": { "name": "Delete a Dimension Conversion Rate Mapping", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cubesoftware.com/currencies/rates/dimension-mappings/:id", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a Dimension Conversion Rate Mapping and all related custom Conversion Rates" }, { "info": { "name": "Export Currency Conversion Rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/rates/export", "headers": [ { "name": "HTTP_ACCEPT", "value": "" }, { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "account_id", "value": "", "type": "query", "description": "The Account dimension IDs to filter the exported records by." }, { "name": "currency_id", "value": "", "type": "query", "description": "The currency IDs to filter the exported records by." }, { "name": "time_id", "value": "", "type": "query", "description": "The Time dimension IDs to filter the exported records by." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint retrieves and organizes the currency conversion rates into a CSV and streams the\n result back to the requester." }, { "info": { "name": "Lists exchange rate types that exist for a given company", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/rates/types", "headers": [ { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "rate_type", "value": "", "type": "query", "description": "A rate type to limit the response to" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists exchange rate types that exist for a given company" }, { "info": { "name": "View Supported Currencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/system-currencies", "headers": [ { "name": "X-Company-ID", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all of the currencies supported" }, { "info": { "name": "currencies_system_currencies_create", "type": "http" }, "http": { "method": "POST", "url": "https://api.cubesoftware.com/currencies/system-currencies", "headers": [ { "name": "X-Company-ID", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets:\n- list()\n- retrieve()\n- create()\n- update()\n- partial_update()\n- destroy()\n\nIf you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the\nappropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block\nrequests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be genera" }, { "info": { "name": "Retrieve A Currency", "type": "http" }, "http": { "method": "GET", "url": "https://api.cubesoftware.com/currencies/system-currencies/:id", "headers": [ { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a currency" }, { "info": { "name": "currencies_system_currencies_update", "type": "http" }, "http": { "method": "PUT", "url": "https://api.cubesoftware.com/currencies/system-currencies/:id", "headers": [ { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets:\n- list()\n- retrieve()\n- create()\n- update()\n- partial_update()\n- destroy()\n\nIf you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the\nappropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block\nrequests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be genera" }, { "info": { "name": "currencies_system_currencies_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.cubesoftware.com/currencies/system-currencies/:id", "headers": [ { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets:\n- list()\n- retrieve()\n- create()\n- update()\n- partial_update()\n- destroy()\n\nIf you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the\nappropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block\nrequests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be genera" }, { "info": { "name": "currencies_system_currencies_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.cubesoftware.com/currencies/system-currencies/:id", "headers": [ { "name": "X-Company-ID", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://portal.cubesoftware.com/o/authorize/", "accessTokenUrl": "https://api.cubesoftware.com/o/token/", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This is a shortcut class that will include all 6 resourceful actions part of the DRF ViewSets:\n- list()\n- retrieve()\n- create()\n- update()\n- partial_update()\n- destroy()\n\nIf you do not want to expose all 6 of these in your ViewSet, then use the CubeAuthenticatedViewSet and add the\nappropriate mixins to it (see rest_framework.mixins). This will allow the api to behave appropriately and block\nrequests to unprocessable endpoints. Furthermore, it will make the drf_spectacular documentation be genera" } ] } ], "bundled": true }