openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 253 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://app.apacta.com/api/v1"}],"info":{"description":"API for a tool to craftsmen used to register working hours, material usage and quality assurance.\n# Endpoint\nThe endpoint `https://app.apacta.com/api/v1` should be used to communicate with the API. API access is only allowed with SSL encrypted connection (https).\n# Authentication\nURL query authentication with an API key is used, so appending `?api_key={api_key}` to the URL where `{api_key}` is found within Apacta settings is used for authentication\n# Pagination\nIf the endpoint returns a `pagination` object it means the endpoint supports pagination - currently it's only possible to change pages with `?page={page_number}` but implementing custom page sizes are on the road map.\n\n\n# Search/filter\nIs experimental but implemented in some cases - see the individual endpoints' docs for further explanation.\n# Ordering\nIs currently experimental, but on some endpoints it's implemented on URL querys so eg. to order Invoices by `invoice_number` appending `?sort=Invoices.invoice_number&direction=desc` would sort the list descending by the value of `invoice_number`.\n# Associations\nIs currently implemented on an experimental basis where you can append eg. `?include=Contacts,Projects` to the `/api/v1/invoices/` endpoint to embed `Contact` and `Project` objects directly.\n# Project Files\nCurrently project files can be retrieved from two endpoints. `/projects/{project_id}/files` handles files uploaded from wall posts or forms. `/projects/{project_id}/project_files` allows uploading and showing files, not belonging to specific form or wall post.\n# Errors/Exceptions\n## 422 (Validation)\nWrite something about how the `errors` object contains keys with the properties that failes validation like:\n```\n {\n \"success\": false,\n \"data\": {\n \"code\": 422,\n \"url\": \"/api/v1/contacts?api_key=5523be3b-30ef-425d-8203-04df7caaa93a\",\n \"message\": \"A validation error occurred\",\n \"errorCount\": 1,\n \"errors\": {\n \"contact_types\": [ ## Property name that failed validation\n \"Contacts must have at least one contact type\" ## Message with further explanation\n ]\n }\n }\n }\n```\n## Code examples\nRunning examples of how to retrieve the 5 most recent forms registered and embed the details of the User that made the form, and eventual products contained in the form\n### Swift\n```\n```\n### Java\n#### OkHttp\n```\n OkHttpClient client = new OkHttpClient();\n\n Request request = new Request.Builder()\n .url(\"https://app.apacta.com/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5\")\n .get()\n .addHeader(\"x-auth-token\", \"{INSERT_YOUR_TOKEN}\")\n .addHeader(\"accept\", \"application/json\")\n .build();\n\n Response response = client.newCall(request).execute();\n```\n#### Unirest\n```\n HttpResponse<String> response = Unirest.get(\"https://app.apacta.com/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5\")\n .header(\"x-auth-token\", \"{INSERT_YOUR_TOKEN}\")\n .header(\"accept\", \"application/json\")\n .asString();\n```\n### Javascript\n#### Native\n```\n var data = null;\n\n var xhr = new XMLHttpRequest();\n\n xhr.addEventListener(\"readystatechange\", function () {\n if (this.readyState === 4) {\n console.log(this.responseText);\n }\n });\n\n xhr.open(\"GET\", \"https://app.apacta.com/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5\");\n xhr.setRequestHeader(\"x-auth-token\", \"{INSERT_YOUR_TOKEN}\");\n xhr.setRequestHeader(\"accept\", \"application/json\");\n\n xhr.send(data);\n```\n#### jQuery\n```\n var settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://app.apacta.com/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5\",\n \"method\": \"GET\",\n \"headers\": {\n \"x-auth-token\": \"{INSERT_YOUR_TOKEN}\",\n \"accept\": \"application/json\",\n }\n }\n\n $.ajax(settings).done(function (response) {\n console.log(response);\n });\n```\n#### NodeJS (Request)\n```\n var request = require(\"request\");\n\n var options = { method: 'GET',\n url: 'https://app.apacta.com/api/v1/forms',\n qs:\n { extended: 'true',\n sort: 'Forms.created',\n direction: 'DESC',\n include: 'Products,CreatedBy',\n limit: '5' },\n headers:\n { accept: 'application/json',\n 'x-auth-token': '{INSERT_YOUR_TOKEN}' } };\n\n request(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n });\n\n```\n### Python 3\n```\n import http.client\n\n conn = http.client.HTTPSConnection(\"app.apacta.com\")\n\n payload = \"\"\n\n headers = {\n 'x-auth-token': \"{INSERT_YOUR_TOKEN}\",\n 'accept': \"application/json\",\n }\n\n conn.request(\"GET\", \"/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5\", payload, headers)\n\n res = conn.getresponse()\n data = res.read()\n\n print(data.decode(\"utf-8\"))\n```\n### C#\n#### RestSharp\n```\n var client = new RestClient(\"https://app.apacta.com/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5\");\n var request = new RestRequest(Method.GET);\n request.AddHeader(\"accept\", \"application/json\");\n request.AddHeader(\"x-auth-token\", \"{INSERT_YOUR_TOKEN}\");\n IRestResponse response = client.Execute(request);\n```\n### Ruby\n```\n require 'uri'\n require 'net/http'\n\n url = URI(\"https://app.apacta.com/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5\")\n\n http = Net::HTTP.new(url.host, url.port)\n http.use_ssl = true\n http.verify_mode = OpenSSL::SSL::VERIFY_NONE\n\n request = Net::HTTP::Get.new(url)\n request[\"x-auth-token\"] = '{INSERT_YOUR_TOKEN}'\n request[\"accept\"] = 'application/json'\n\n response = http.request(request)\n puts response.read_body\n```\n### PHP (HttpRequest)\n```\n <?php\n\n $request = new HttpRequest();\n $request->setUrl('https://app.apacta.com/api/v1/forms');\n $request->setMethod(HTTP_METH_GET);\n\n $request->setQueryData(array(\n 'extended' => 'true',\n 'sort' => 'Forms.created',\n 'direction' => 'DESC',\n 'include' => 'Products,CreatedBy',\n 'limit' => '5'\n ));\n\n $request->setHeaders(array(\n 'accept' => 'application/json',\n 'x-auth-token' => '{INSERT_YOUR_TOKEN}'\n ));\n\n try {\n $response = $request->send();\n\n echo $response->getBody();\n } catch (HttpException $ex) {\n echo $ex;\n }\n```\n### Shell (cURL)\n```\n\n $ curl --request GET --url 'https://app.apacta.com/api/v1/forms?extended=true&sort=Forms.created&direction=DESC&include=Products%2CCreatedBy&limit=5' --header 'accept: application/json' --header 'x-auth-token: {INSERT_YOUR_TOKEN}'\n\n```","title":"Apacta","version":"0.0.42","x-apisguru-categories":["time_management","project_management"],"x-logo":{"url":"https://twitter.com/apactadk/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"http://apidoc.apacta.com/swagger.yaml","version":"3.0"}],"x-providerName":"apacta.com"},"tags":[{"name":"Activities"},{"description":"Experimental","name":"TimeEntries"},{"description":"Experimental","name":"TimeEntryIntervals"},{"description":"Experimental","name":"TimeEntryTypes"},{"description":"Experimental","name":"TimeEntryUnitTypes"},{"description":"Experimental","name":"TimeEntryValueTypes"},{"name":"Contacts"},{"name":"ContactPersons"},{"name":"Invoices"},{"name":"InvoiceEmails"},{"name":"InvoiceFiles"},{"name":"InvoiceLineTextTemplates"},{"name":"ProjectStatusTypes"}],"paths":{"/activities":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Activity"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"summary":"Get a list of activities","tags":["Activities"]},"post":{"requestBody":{"$ref":"#/components/requestBodies/Activity"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"summary":"Create an activity","tags":["Activities"]}},"/activities/bulkDelete":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionRequestBody"}}},"description":"Activities ids","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad Request"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"}},"summary":"Bulk delete activities","tags":["Activities"]}},"/activities/{activity_id}":{"delete":{"parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Record not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"summary":"Delete an activity","tags":["Activities"]},"put":{"parameters":[{"in":"path","name":"activity_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Activity"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Record not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"summary":"Edit an activity","tags":["Activities"]}},"/cities":{"get":{"parameters":[{"description":"Used to search for a city with specific zip code","in":"query","name":"zip_code","required":false,"schema":{"type":"string"}},{"description":"Used to search for a city by name","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Used to search for a city without filtering by country","in":"query","name":"include_all","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/City"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get list of cities supported in Apacta","tags":["Cities"]}},"/cities/{city_id}":{"get":{"parameters":[{"in":"path","name":"city_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/City"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get details about one city","tags":["Cities"]}},"/clocking_records":{"get":{"parameters":[{"description":"Used to search for active clocking records","in":"query","name":"active","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ClockingRecord"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of clocking records","tags":["ClockingRecords"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"checkin_latitude":{"type":"string"},"checkin_longitude":{"type":"string"},"checkout_latitude":{"type":"string"},"checkout_longitude":{"type":"string"},"project_id":{"format":"uuid","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"Successfully added clocking record"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Create clocking record for authenticated user","tags":["ClockingRecords"]}},"/clocking_records/checkout":{"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"Successfully checked out"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Checkout active clocking record for authenticated user","tags":["ClockingRecords"]}},"/clocking_records/{clocking_record_id}":{"delete":{"parameters":[{"in":"path","name":"clocking_record_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"string"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Delete a clocking record","tags":["ClockingRecords"]},"get":{"parameters":[{"in":"path","name":"clocking_record_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ClockingRecord"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Clocking record not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Details of 1 clocking_record","tags":["ClockingRecords"]},"put":{"parameters":[{"in":"path","name":"clocking_record_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Edit a clocking record","tags":["ClockingRecords"]}},"/companies":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Company"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of companies","tags":["Companies"]}},"/companies/subscription_self_service":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/SubscriptionSelfServiceRequestBody"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"Self service url"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"URL for subscription selfservice","tags":["Companies"]}},"/companies/{company_id}":{"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Company"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"Company object"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Details of 1 company","tags":["Companies"]}},"/companies/{company_id}/companies_integration_feature_settings":{"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CompaniesIntegrationFeatureSetting"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"List a company integration feature settings","tags":["Companies"]},"post":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"integration_feature_setting_id":{"format":"uuid","type":"string"},"value":{"type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Add a company integration feature setting","tags":["Companies"]}},"/companies/{company_id}/companies_integration_feature_settings/{c_integration_feature_setting_id}":{"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"c_integration_feature_setting_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CompaniesIntegrationFeatureSetting"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"IntegrationFeatureSetting not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"View a company integration feature setting","tags":["Companies"]},"put":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"c_integration_feature_setting_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CompaniesIntegrationFeatureSetting"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"IntegrationFeatureSetting not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Edit a company integration feature setting","tags":["Companies"]}},"/companies/{company_id}/form_templates/":{"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"form_template_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of company form templates","tags":["Companies"]}},"/companies/{company_id}/form_templates/{form_template_id}":{"delete":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Automatically added","in":"path","name":"form_template_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Companies form template not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Delete a form template company","tags":["Companies"]},"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"Automatically added","in":"path","name":"form_template_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Form template company not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a company form template","tags":["Companies"]}},"/companies/{company_id}/integration_feature_settings":{"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IntegrationFeatureSetting"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of integration feature settings","tags":["Companies"]}},"/companies/{company_id}/integration_feature_settings/{integration_feature_setting_id}":{"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"integration_feature_setting_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/IntegrationFeatureSetting"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"IntegrationFeatureSetting not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Show details of 1 integration feature setting","tags":["Companies"]}},"/companies/{company_id}/integration_settings":{"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"The identifier of an ERP integration","in":"query","name":"identifier","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CompaniesIntegrationSetting"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of company integration settings","tags":["Companies"]},"post":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Companiesintegrationsetting"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Add a company integration setting","tags":["Companies"]}},"/companies/{company_id}/integration_settings/{companies_integration_setting_id}":{"delete":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"companies_integration_setting_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Companies integration setting not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Delete a company integration setting","tags":["Companies"]},"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"companies_integration_setting_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CompaniesIntegrationSetting"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Companies integration setting not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a company integration setting","tags":["Companies"]},"put":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"companies_integration_setting_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Companies integration setting not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Edit a company integration setting","tags":["Companies"]}},"/companies/{company_id}/price_margins/{price_margins_id}":{"delete":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"price_margin_id","required":true,"schema":{"type":"string"}},{"description":"Automatically added","in":"path","name":"price_margins_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Companies integration setting not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Delete a company price margin","tags":["Companies"]},"get":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Automatically added","in":"path","name":"price_margins_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CompanyPriceMargins"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of company price margins","tags":["Companies"]},"post":{"parameters":[{"in":"path","name":"company_id","required":true,"schema":{"type":"string"}},{"description":"Automatically added","in":"path","name":"price_margins_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"format":"uuid","type":"string"},"value":{"type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Company not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Add a company price margin","tags":["Companies"]}},"/companies_vendors":{"get":{"operationId":"getCompaiesVendorsList","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CompaniesVendor"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of companies vendors","tags":["CompaniesVendors"]},"post":{"operationId":"addCompaniesVendor","requestBody":{"$ref":"#/components/requestBodies/addCompaniesVendorCompaniesvendor"},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"Successfully added companies vendor"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Add a new companies vendor","tags":["CompaniesVendors"]}},"/companies_vendors/bulkDelete":{"delete":{"operationId":"bulkCompaniesVendors","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionRequestBody"}}},"description":"Companies vendors ids","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Forbidden"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Bulk delete companies vendors","tags":["CompaniesVendors"]}},"/companies_vendors/{companies_vendor_id}":{"delete":{"parameters":[{"in":"path","name":"companies_vendor_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"string"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Delete a companies vendor","tags":["CompaniesVendors"]},"get":{"operationId":"getCompaniesVendor","parameters":[{"in":"path","name":"companies_vendor_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CompaniesVendor"},"success":{"default":true,"type":"boolean"}}}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a companies vendor","tags":["CompaniesVendors"]},"put":{"operationId":"editCompaniesVendor","parameters":[{"in":"path","name":"companies_vendor_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/addCompaniesVendorCompaniesvendor"},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Edit a companies vendor","tags":["CompaniesVendors"]}},"/companies_vendors/{companies_vendor_id}/expense_statistics":{"get":{"operationId":"getCompaniesVendorsExpenseStatistics","parameters":[{"in":"path","name":"companies_vendor_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"last_month":{"items":{"properties":{"amount":{"format":"float","type":"number"},"count":{"format":"int32","type":"number"}},"type":"object"},"type":"array"},"thirty_days":{"items":{"properties":{"amount":{"format":"float","type":"number"},"count":{"format":"int32","type":"number"}},"type":"object"},"type":"array"},"vendor_id":{"format":"uuid","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get companies vendor expense statistics","tags":["CompaniesVendors"]}},"/company_settings":{"get":{"operationId":"getCompaySettingsList","parameters":[{"description":"Filter by name","in":"query","name":"name","schema":{"type":"string"}},{"description":"Filter by description","in":"query","name":"description","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/CompanySettings"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"IntegrationFeatureSetting not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of company settings","tags":["CompanySettings"]}},"/contact_custom_field_attributes":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContactCustomFieldAttribute"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of contact custom field attributes","tags":["ContactCustomFieldAttributes"]}},"/contact_custom_field_attributes/{contact_custom_field_attribute_id}":{"get":{"parameters":[{"in":"path","name":"contact_custom_field_attribute_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContactCustomFieldAttribute"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"ContactCustomFieldAttribute not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Details of 1 contact custom field attribute","tags":["ContactCustomFieldAttributes"]}},"/contact_types":{"get":{"parameters":[{"description":"Search for specific identifier value","in":"query","name":"identifier","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContactType"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get list of contact types supported in Apacta","tags":["ContactTypes"]}},"/contact_types/{contact_type_id}":{"get":{"parameters":[{"in":"path","name":"contact_type_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContactType"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get details about one contact type","tags":["ContactTypes"]}},"/contacts":{"get":{"parameters":[{"description":"Used to search for a contact with a specific name","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Search for values in CVR field","in":"query","name":"cvr","schema":{"type":"string"}},{"description":"Search for values in EAN field","in":"query","name":"ean","schema":{"type":"string"}},{"description":"Search for values in ERP id field","in":"query","name":"erp_id","schema":{"type":"string"}},{"description":"Used to show only contacts with with one specific `ContactType`","in":"query","name":"contact_type","schema":{"format":"uuid","type":"string"}},{"description":"Used to show only contacts with with one specific `City`","in":"query","name":"city","schema":{"type":"string"}},{"in":"query","name":"modified_gte","schema":{"format":"datetime","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of contacts","tags":["Contacts"]},"post":{"requestBody":{"$ref":"#/components/requestBodies/Contact"},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"Successfully added contact"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Add a new contact","tags":["Contacts"]}},"/contacts/bulkDelete":{"delete":{"operationId":"bulkDeleteContacts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkActionRequestBody"}}},"description":"Contact ids","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptySuccessResponse"}}},"description":"OK"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Forbidden"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Bulk delete contacts","tags":["Contacts"]}},"/contacts/{contact_id}":{"delete":{"parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"string"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Delete a contact","tags":["Contacts"]},"get":{"parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Contact"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Contact not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Details of 1 contact","tags":["Contacts"]},"put":{"parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Contact"},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Edit a contact","tags":["Contacts"]}},"/contacts/{contact_id}/contact_custom_field_values":{"get":{"parameters":[{"description":"Automatically added","in":"path","name":"contact_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContactCustomFieldValue"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of contact custom field values","tags":["ContactCustomFieldValue"]}},"/contacts/{contact_id}/contact_persons":{"get":{"description":"Get a list of contact people associated with a contact","operationId":"getContactPersonsList","parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}},{"in":"query","name":"q","schema":{"type":"string"}},{"in":"query","name":"created_gte","schema":{"format":"date","type":"string"}},{"in":"query","name":"created_lte","schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ContactPerson"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}}}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a list of contact people","tags":["ContactPersons"]},"post":{"operationId":"addContactPerson","parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/addContactPersonContactperson"},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"data":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"Successfully added contact person"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorValidation"}}},"description":"Validation error"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Add a new contact person to a contact","tags":["ContactPersons"]}},"/contacts/{contact_id}/contact_persons/{contact_person_id}":{"delete":{"parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"contact_person_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"string"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Delete a contact person","tags":["ContactPersons"]},"get":{"operationId":"getContactPerson","parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"contact_person_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/ContactPerson"},"success":{"default":true,"type":"boolean"}}}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get a contact person","tags":["ContactPersons"]},"put":{"operationId":"editContactPerson","parameters":[{"in":"path","name":"contact_id","required":true,"schema":{"type":"string"}},{"in":"path","name":"contact_person_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/addContactPersonContactperson"},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"type":"object"},"type":"array"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Edit a contact person","tags":["ContactPersons"]}},"/countries":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Countries"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get list of countries supported in Apacta","tags":["Countries"]}},"/countries/{country_id}":{"get":{"parameters":[{"in":"path","name":"country_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Countries"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get details about one country","tags":["Countries"]}},"/currencies":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Currency"},"type":"array"},"pagination":{"$ref":"#/components/schemas/PaginationDetails"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Token":[]},{"api_key":[]}],"summary":"Get list of currencies supported in Apacta","tags":["Currencies"]}},"/currencies/{currency_id}":{"get":{"parameters":[{"in":"path","name":"currency_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/Currency"},"success":{"default":true,"type":"boolean"}},"type":"object"}}},"description":"OK"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFound"}}},"description":"Not found"}},"security":[{"X-Auth-Tok