{"items":[{"type":"link","label":"Fennoa API","link":"/apis/v2","routeSlug":"/apis/v2","content":{"contentType":"overview","meta":{"name":"Fennoa API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/apis/v2/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/apis/v2/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fennoa API (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API is not live yet. This documentation is for preview purposes only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Everything you need to integrate Fennoa into your own systems. Read and manage payroll data, employees, and more through a simple REST API."},"children":[]}]}]}]}],"sectionId":"/apis/v2"}],"sectionId":"/apis/v2"}]}]}},{"type":"group","label":"Authentication","link":"/apis/v2/authentication","routeSlug":"/apis/v2/authentication","items":[{"type":"link","label":"OAuth 2.0 Client Credentials","link":"/apis/v2/authentication/oauth-2.0-client-credentials","routeSlug":"/apis/v2/authentication/oauth-2.0-client-credentials","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"OAuth 2.0 Client Credentials"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"authentication/oauth-2.0-client-credentials"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Client Credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API uses the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Client Credentials"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant for authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain an access token by sending a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to the appropriate token endpoint with your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.fennoa.com/oauth/token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.sandbox.fennoa.com/oauth/token"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the access token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of all subsequent requests:"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Required Headers","link":"/apis/v2/authentication/required-headers","routeSlug":"/apis/v2/authentication/required-headers","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Required Headers"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"authentication/required-headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required Headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests must include the following headers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <token>"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 access token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<company_code>"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the target company"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response content type"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication"}],"panels":[]}]}},{"type":"group","label":"General","link":"/apis/v2/general","routeSlug":"/apis/v2/general","items":[{"label":"Get API status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/general/getstatus","routeSlug":"/apis/v2/general/getstatus","metadata":{"seo":{"title":"Get API status","description":"Get API status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatus","name":"Get API status","isWebhook":false,"pointer":"/paths/~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get API status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related resources to include in the response. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_maintenances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/status","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[],"query":[{"name":"include","in":"query","schemaId":"schema_14"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/status","href":"general/getstatus","openApiOperationId":"getStatus","summary":"Get API status","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"API status.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}},"schemaId":"schema_15"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_15","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/general/getstatus"}],"panels":[]}]},"httpPath":"/status"}],"content":{"contentType":"group","meta":{"name":"General"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"General","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/status","summary":"Get API status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/general/getstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Payroll","link":"/apis/v2/payroll","routeSlug":"/apis/v2/payroll","items":[{"label":"List employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payroll/listpayrollemployees","routeSlug":"/apis/v2/payroll/listpayrollemployees","metadata":{"seo":{"title":"List employees","description":"List employees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPayrollEmployees","name":"List employees","isWebhook":false,"pointer":"/paths/~1payroll~1employees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[employment_status]","in":"query","schemaId":"schema_17","description":"Filter employees by employment status."},{"name":"include","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related resources to include in the response. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_employment.employment_group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payroll~1employees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payroll/employees","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[],"query":[{"name":"filter[employment_status]","in":"query","schemaId":"schema_17"},{"name":"include","in":"query","schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payroll/employees","href":"payroll/listpayrollemployees","openApiOperationId":"listPayrollEmployees","summary":"List employees","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of employees.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"}],"pointer":"/paths/~1payroll~1employees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payroll/listpayrollemployees"}],"panels":[]}]},"httpPath":"/payroll/employees"},{"label":"Create employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payroll/createpayrollemployee","routeSlug":"/apis/v2/payroll/createpayrollemployee","metadata":{"seo":{"title":"Create employee","description":"Create employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayrollEmployee","name":"Create employee","isWebhook":false,"pointer":"/paths/~1payroll~1employees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayrollEmployeeCreate"}},"schemaId":"components/schemas/PayrollEmployeeCreate","pointer":"/paths/~1payroll~1employees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payroll/employees","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PayrollEmployeeCreate"}},"responseCodes":["201"],"pointer":"/payroll/employees","href":"payroll/createpayrollemployee","openApiOperationId":"createPayrollEmployee","summary":"Create employee","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"schemaId":"components/schemas/PayrollEmployeeCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PayrollEmployeeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Get employee.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20"}],"pointer":"/paths/~1payroll~1employees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payroll/createpayrollemployee"}],"panels":[]}]},"httpPath":"/payroll/employees"},{"label":"Get payroll employee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/payroll/getpayrollemployee","routeSlug":"/apis/v2/payroll/getpayrollemployee","metadata":{"seo":{"title":"Get payroll employee","description":"Get payroll employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayrollEmployee","name":"Get payroll employee","isWebhook":false,"pointer":"/paths/~1payroll~1employees~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payroll employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_21","required":true}],"pointer":"/paths/~1payroll~1employees~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payroll/employees/{id}","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/payroll/employees/{id}","href":"payroll/getpayrollemployee","openApiOperationId":"getPayrollEmployee","summary":"Get payroll employee","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get employee.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20"}],"pointer":"/paths/~1payroll~1employees~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payroll/getpayrollemployee"}],"panels":[]}]},"httpPath":"/payroll/employees/{id}"}],"content":{"contentType":"group","meta":{"name":"Payroll"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payroll","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payroll/employees","summary":"List employees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payroll/listpayrollemployees","deprecated":false},{"title":"/payroll/employees","summary":"Create employee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payroll/createpayrollemployee","deprecated":false},{"title":"/payroll/employees/{id}","summary":"Get payroll employee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payroll/getpayrollemployee","deprecated":false}]}]}]}]}},{"type":"group","label":"Dimensions","link":"/apis/v2/dimensions","routeSlug":"/apis/v2/dimensions","items":[{"label":"Create dimension type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/createdimensiontype","routeSlug":"/apis/v2/dimensions/createdimensiontype","metadata":{"seo":{"title":"Create dimension type","description":"Create dimension type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDimensionType","name":"Create dimension type","isWebhook":false,"pointer":"/paths/~1dimension-types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create dimension type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionTypeCreate"}},"schemaId":"components/schemas/DimensionTypeCreate","pointer":"/paths/~1dimension-types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dimension-types","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DimensionTypeCreate"}},"responseCodes":["201","500"],"pointer":"/dimension-types","href":"dimensions/createdimensiontype","openApiOperationId":"createDimensionType","summary":"Create dimension type","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"schemaId":"components/schemas/DimensionTypeCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionTypeCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A dimension type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimension-types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/createdimensiontype"}],"panels":[]}]},"httpPath":"/dimension-types"},{"label":"List dimension types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/listdimensiontypes","routeSlug":"/apis/v2/dimensions/listdimensiontypes","metadata":{"seo":{"title":"List dimension types","description":"List dimension types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDimensionTypes","name":"List dimension types","isWebhook":false,"pointer":"/paths/~1dimension-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List dimension types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dimension-types","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/dimension-types","href":"dimensions/listdimensiontypes","openApiOperationId":"listDimensionTypes","summary":"List dimension types","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of dimension types.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimension-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/listdimensiontypes"}],"panels":[]}]},"httpPath":"/dimension-types"},{"label":"Update dimension type","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/updatedimensiontype","routeSlug":"/apis/v2/dimensions/updatedimensiontype","metadata":{"seo":{"title":"Update dimension type","description":"Update dimension type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDimensionType","name":"Update dimension type","isWebhook":false,"pointer":"/paths/~1dimension-types~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update dimension type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_21","required":true}],"pointer":"/paths/~1dimension-types~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionTypeUpdate"}},"schemaId":"components/schemas/DimensionTypeUpdate","pointer":"/paths/~1dimension-types~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/dimension-types/{id}","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DimensionTypeUpdate"}},"responseCodes":["200","500"],"pointer":"/dimension-types/{id}","href":"dimensions/updatedimensiontype","openApiOperationId":"updateDimensionType","summary":"Update dimension type","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"schemaId":"components/schemas/DimensionTypeUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionTypeUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A dimension type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimension-types~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/updatedimensiontype"}],"panels":[]}]},"httpPath":"/dimension-types/{id}"},{"label":"Get dimension type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/getdimensiontype","routeSlug":"/apis/v2/dimensions/getdimensiontype","metadata":{"seo":{"title":"Get dimension type","description":"Get dimension type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDimensionType","name":"Get dimension type","isWebhook":false,"pointer":"/paths/~1dimension-types~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dimension type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_21","required":true}],"pointer":"/paths/~1dimension-types~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dimension-types/{id}","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/dimension-types/{id}","href":"dimensions/getdimensiontype","openApiOperationId":"getDimensionType","summary":"Get dimension type","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A dimension type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimension-types~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/getdimensiontype"}],"panels":[]}]},"httpPath":"/dimension-types/{id}"},{"label":"List dimensions for a dimension type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/listdimensiontypedimensions","routeSlug":"/apis/v2/dimensions/listdimensiontypedimensions","metadata":{"seo":{"title":"List dimensions for a dimension type","description":"List dimensions for a dimension type"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDimensionTypeDimensions","name":"List dimensions for a dimension type","isWebhook":false,"pointer":"/paths/~1dimension-types~1{id}~1dimensions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List dimensions for a dimension type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_21","required":true}],"pointer":"/paths/~1dimension-types~1{id}~1dimensions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related resources to include in the response. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimension_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1dimension-types~1{id}~1dimensions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dimension-types/{id}/dimensions","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_21"}],"query":[{"name":"include","in":"query","schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/dimension-types/{id}/dimensions","href":"dimensions/listdimensiontypedimensions","openApiOperationId":"listDimensionTypeDimensions","summary":"List dimensions for a dimension type","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of dimensions for the given dimension type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimension-types~1{id}~1dimensions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/listdimensiontypedimensions"}],"panels":[]}]},"httpPath":"/dimension-types/{id}/dimensions"},{"label":"Create dimension","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/createdimension","routeSlug":"/apis/v2/dimensions/createdimension","metadata":{"seo":{"title":"Create dimension","description":"Create dimension"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDimension","name":"Create dimension","isWebhook":false,"pointer":"/paths/~1dimensions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create dimension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionCreate"}},"schemaId":"components/schemas/DimensionCreate","pointer":"/paths/~1dimensions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dimensions","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DimensionCreate"}},"responseCodes":["201","500"],"pointer":"/dimensions","href":"dimensions/createdimension","openApiOperationId":"createDimension","summary":"Create dimension","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"schemaId":"components/schemas/DimensionCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A dimension.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimensions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/createdimension"}],"panels":[]}]},"httpPath":"/dimensions"},{"label":"Get dimension","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/getdimension","routeSlug":"/apis/v2/dimensions/getdimension","metadata":{"seo":{"title":"Get dimension","description":"Get dimension"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDimension","name":"Get dimension","isWebhook":false,"pointer":"/paths/~1dimensions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dimension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_21","required":true}],"pointer":"/paths/~1dimensions~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of related resources to include in the response. Supported values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dimension_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1dimensions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dimensions/{id}","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_21"}],"query":[{"name":"include","in":"query","schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/dimensions/{id}","href":"dimensions/getdimension","openApiOperationId":"getDimension","summary":"Get dimension","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A dimension with its related dimension type. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=dimension_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is requested."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimensions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/getdimension"}],"panels":[]}]},"httpPath":"/dimensions/{id}"},{"label":"Update dimension","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/v2/dimensions/updatedimension","routeSlug":"/apis/v2/dimensions/updatedimension","metadata":{"seo":{"title":"Update dimension","description":"Update dimension"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDimension","name":"Update dimension","isWebhook":false,"pointer":"/paths/~1dimensions~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update dimension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}]},{"schemes":[{"name":"OAuth2Sandbox","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_21","required":true}],"pointer":"/paths/~1dimensions~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionUpdate"}},"schemaId":"components/schemas/DimensionUpdate","pointer":"/paths/~1dimensions~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/dimensions/{id}","servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_21"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]},{"schemes":[{"id":"OAuth2Sandbox","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DimensionUpdate"}},"responseCodes":["200","500"],"pointer":"/dimensions/{id}","href":"dimensions/updatedimension","openApiOperationId":"updateDimension","summary":"Update dimension","securityGroups":[{"OAuth2":[]},{"OAuth2Sandbox":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}],"schemaId":"components/schemas/DimensionUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DimensionUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A dimension.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1dimensions~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"500","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dimensions/updatedimension"}],"panels":[]}]},"httpPath":"/dimensions/{id}"}],"content":{"contentType":"group","meta":{"name":"Dimensions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dimensions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dimension-types","summary":"Create dimension type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dimensions/createdimensiontype","deprecated":false},{"title":"/dimension-types","summary":"List dimension types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dimensions/listdimensiontypes","deprecated":false},{"title":"/dimension-types/{id}","summary":"Update dimension type","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/dimensions/updatedimensiontype","deprecated":false},{"title":"/dimension-types/{id}","summary":"Get dimension type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dimensions/getdimensiontype","deprecated":false},{"title":"/dimension-types/{id}/dimensions","summary":"List dimensions for a dimension type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dimensions/listdimensiontypedimensions","deprecated":false},{"title":"/dimensions","summary":"Create dimension","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dimensions/createdimension","deprecated":false},{"title":"/dimensions/{id}","summary":"Get dimension","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dimensions/getdimension","deprecated":false},{"title":"/dimensions/{id}","summary":"Update dimension","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/dimensions/updatedimension","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ScheduledMaintenance":{"id":"components/schemas/ScheduledMaintenance","kind":"json-schema","title":"ScheduledMaintenance","data":{"type":"object","properties":{"service":{"type":"string","example":"fennoa"},"description":{"type":"object","additionalProperties":{"type":"string"},"example":{"en":"Description in english"}},"starts_at":{"type":"string","example":"2030-06-12 13:00:00"},"ends_at":{"type":"string","example":"2030-06-12 14:00:00"}}}},"components/schemas/PayrollEmployeeSimple":{"id":"components/schemas/PayrollEmployeeSimple","kind":"json-schema","title":"PayrollEmployeeSimple","data":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the employee in Fennoa.","example":123},"person_number":{"type":"string","description":"User modifiable employee identifier in Fennoa.","example":"P1005"},"first_name":{"type":"string","example":"Veera"},"last_name":{"type":"string","example":"Virtanen"},"identity_number":{"type":["string","null"],"example":"010101-900P"},"active_employment":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The employee's current active employment. Only included when requested via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=active_employment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. Null if the employee has no active employment."},"children":[]}]}]}],"properties":{"id":{"type":"integer","description":"Identifier of the employment.","example":789},"employment_group":{"type":"object","properties":{"id":{"type":"integer","example":2},"name":{"type":"string","minLength":1,"maxLength":100,"example":"Tuntipalkat"}}}}}}}},"components/schemas/NextCursor":{"id":"components/schemas/NextCursor","kind":"json-schema","title":"NextCursor","data":{"type":["string","null"],"description":"Base64-encoded cursor for the next page, or null when there is no next page.","example":"eyJpZCI6MX0="}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","required":["street","city","postal_code","country"],"properties":{"street":{"type":"string","maxLength":100,"example":"Esimerkkikatu 1"},"postal_code":{"type":"string","maxLength":10,"example":"00100"},"city":{"type":"string","maxLength":50,"example":"Helsinki"},"country":{"type":"string","maxLength":2,"description":"ISO 3166-1 alpha-2 country code","example":"FI"}}}},"components/schemas/PayrollEmployeeCreate":{"id":"components/schemas/PayrollEmployeeCreate","kind":"json-schema","title":"PayrollEmployeeCreate","data":{"type":"object","required":["person_number","first_name","last_name","address"],"properties":{"person_number":{"type":"string","maxLength":20,"description":"User modifiable employee identifier in Fennoa.","example":"P1005"},"first_name":{"type":"string","maxLength":100,"example":"Veera"},"last_name":{"type":"string","maxLength":100,"example":"Virtanen"},"date_of_birth":{"type":"string","format":"date"},"identity_number":{"type":"string","maxLength":15,"example":"010101-900P"},"tax_number":{"type":"integer","minLength":12,"maxLength":12,"example":100012345678},"email":{"type":"string","format":"email","maxLength":100,"example":"vvirtanen@example.com"},"phone":{"type":"string","minLength":3,"maxLength":20,"example":"+35844123456"},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}]},"hire_date":{"type":"string","format":"date"},"employment_group_id":{"type":"integer","example":3},"payroll_delivery_method":{"type":"string","enum":["no_delivery","email","esalary"],"example":"esalary"},"iban":{"type":"string","example":"FI21 1234 5600 0007 85"},"bic":{"type":"string","example":"NDEAFIHH"},"locale":{"type":"string","enum":["fi","sv","en"],"description":"ISO 639-1 language code","example":"fi"},"international_situations":{"type":"object","properties":{"foreign_person_id":{"type":"string","example":"M1234567A"},"tin":{"type":"string","description":"Tax Identification Number","example":"000-00-0000"},"gender":{"type":"string","enum":["male","female","other"],"example":"female"},"insured_in_finland":{"type":"boolean"},"a1_certificate_id":{"type":"integer","enum":[1,2,3],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1 certificate / social security situation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" From Finland A1 certificate or agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To Finland A1 certificate or agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Non-EU/EEA country/non-social security agreement country (third country)"},"children":[]}]}]}]}],"example":2},"has_non_resident_tax_liability":{"type":"boolean"},"work_address":{"allOf":[{"$ref":"#/components/schemas/Address"}]}}}}}},"components/schemas/PayrollEmployee":{"id":"components/schemas/PayrollEmployee","kind":"json-schema","title":"PayrollEmployee","data":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the employee in Fennoa.","example":123},"person_number":{"type":"string","description":"User modifiable employee identifier in Fennoa.","example":"P1005"},"first_name":{"type":"string","example":"Veera"},"last_name":{"type":"string","example":"Virtanen"},"date_of_birth":{"type":["string","null"],"format":"date"},"identity_number":{"type":["string","null"],"example":"010101-900P"},"tax_number":{"type":["integer","null"],"example":100012345678},"email":{"type":["string","null"],"example":"vvirtanen@example.com"},"phone":{"type":["string","null"],"example":"+35844123456"},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}]},"hire_date":{"type":["string","null"],"format":"date"},"employment_group_id":{"type":["integer","null"],"description":"ID of the employment group the employee belongs to.","example":3},"payroll_delivery_method":{"type":"string","enum":["no_delivery","email","esalary"],"example":"esalary"},"iban":{"type":["string","null"],"example":"FI2112345600000785"},"bic":{"type":["string","null"],"example":"NDEAFIHH"},"locale":{"type":["string","null"],"enum":["fi","sv","en",null],"description":"ISO 639-1 language code","example":"fi"},"international_situations":{"type":"object","properties":{"foreign_person_id":{"type":["string","null"],"example":"M1234567A"},"tin":{"type":["string","null"],"description":"Tax Identification Number","example":"000-00-0000"},"gender":{"type":["string","null"],"enum":["male","female","other",null],"example":"female"},"insured_in_finland":{"type":"boolean"},"a1_certificate_id":{"type":["integer","null"],"enum":[1,2,3,null],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A1 certificate / social security situation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" From Finland A1 certificate or agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To Finland A1 certificate or agreement"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Non-EU/EEA country/non-social security agreement country (third country)"},"children":[]}]}]}]}],"example":2},"has_non_resident_tax_liability":{"type":"boolean"},"work_address":{"oneOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]}}}}}},"components/schemas/DimensionType":{"id":"components/schemas/DimensionType","kind":"json-schema","title":"DimensionType","data":{"type":"object","required":["id","name","description","active"],"properties":{"id":{"type":"integer","description":"Identifier of the dimension type.","example":1},"name":{"type":"object","description":"Localized name of the dimension type.","required":["fi","en","sv"],"properties":{"fi":{"type":"string","example":"Projekti"},"en":{"type":"string","example":"Project"},"sv":{"type":"string","example":"Projekt"}}},"description":{"type":"object","description":"Localized description of the dimension type.","required":["fi"],"properties":{"fi":{"type":"string","example":"Esimerkkiprojekti"}}},"active":{"type":"boolean","description":"Indicates whether the dimension type is in use.","example":true}}}},"components/schemas/DimensionTypeCreate":{"id":"components/schemas/DimensionTypeCreate","kind":"json-schema","title":"DimensionTypeCreate","data":{"type":"object","required":["name"],"properties":{"name":{"type":"object","description":"Localized name of the dimension type.","required":["fi"],"properties":{"fi":{"type":"string","example":"Projekti"},"en":{"type":"string","example":"Project"},"sv":{"type":"string","example":"Projekt"}}},"description":{"type":"object","description":"Localized description of the dimension type.","properties":{"fi":{"type":"string","example":"Esimerkkiprojekti"}}},"active":{"type":"boolean","description":"Indicates whether the dimension type is in use.","example":true}}}},"components/schemas/DimensionTypeUpdate":{"id":"components/schemas/DimensionTypeUpdate","kind":"json-schema","title":"DimensionTypeUpdate","data":{"type":"object","properties":{"name":{"type":"object","description":"Localized name of the dimension type.","properties":{"fi":{"type":"string","example":"Projekti"},"en":{"type":"string","example":"Project"},"sv":{"type":"string","example":"Projekt"}}},"description":{"type":"object","description":"Localized description of the dimension type.","properties":{"fi":{"type":"string","example":"Esimerkkiprojekti"}}},"active":{"type":"boolean","description":"Indicates whether the dimension type is in use.","example":true}}}},"components/schemas/Dimension":{"id":"components/schemas/Dimension","kind":"json-schema","title":"Dimension","data":{"type":"object","required":["id","dimension_type_id","code","name","description","active","valid_from","valid_to"],"properties":{"id":{"type":"integer","description":"Identifier of the dimension.","example":10},"dimension_type_id":{"type":"integer","description":"ID of the dimension type this dimension belongs to.","example":1},"code":{"type":"string","description":"User-defined code for the dimension.","example":"CC-001"},"name":{"type":"object","description":"Localized name of the dimension.","required":["fi"],"properties":{"fi":{"type":"string","example":"Kustannuspaikka 1"},"en":{"type":"string","example":"Cost center 1"},"sv":{"type":"string","example":"Kostnadsställe 1"}}},"description":{"type":"object","description":"Localized description of the dimension.","required":["fi"],"properties":{"fi":{"type":"string","example":"Esimerkkikustannuspaikka"}}},"active":{"type":"boolean","description":"Indicates whether the dimension is in use.","example":true},"valid_from":{"type":["string","null"],"format":"date","description":"Date from which the dimension is valid.","example":"2024-01-01"},"valid_to":{"type":["string","null"],"format":"date","description":"Date until which the dimension is valid.","example":"2024-12-31"}}}},"components/schemas/DimensionWithDimensionType":{"id":"components/schemas/DimensionWithDimensionType","kind":"json-schema","title":"DimensionWithDimensionType","data":{"allOf":[{"$ref":"#/components/schemas/Dimension"},{"type":"object","required":["dimension_type"],"properties":{"dimension_type":{"$ref":"#/components/schemas/DimensionType"}}}]}},"components/schemas/DimensionCreate":{"id":"components/schemas/DimensionCreate","kind":"json-schema","title":"DimensionCreate","data":{"type":"object","required":["dimension_type_id","code","name"],"properties":{"dimension_type_id":{"type":"integer","description":"ID of the dimension type this dimension belongs to.","example":1},"code":{"type":"string","description":"User-defined code for the dimension.","maxLength":16,"example":"CC-001"},"name":{"type":"object","description":"Localized name of the dimension.","required":["fi"],"properties":{"fi":{"type":"string","maxLength":50,"example":"Kustannuspaikka 1"},"en":{"type":"string","maxLength":50,"example":"Cost center 1"},"sv":{"type":"string","maxLength":50,"example":"Kostnadsställe 1"}}},"description":{"type":"object","description":"Localized description of the dimension.","properties":{"fi":{"type":"string","maxLength":250,"example":"Esimerkkikustannuspaikka"}}},"active":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the dimension is in use. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true},"valid_from":{"type":["string","null"],"format":"date","example":"2024-01-01"},"valid_to":{"type":["string","null"],"format":"date","example":"2024-12-31"}}}},"components/schemas/DimensionUpdate":{"id":"components/schemas/DimensionUpdate","kind":"json-schema","title":"DimensionUpdate","data":{"type":"object","properties":{"dimension_type_id":{"type":"integer","description":"ID of the dimension type this dimension belongs to.","example":1},"code":{"type":"string","description":"User-defined code for the dimension.","maxLength":16,"example":"CC-001"},"name":{"type":"object","description":"Localized name of the dimension.","properties":{"fi":{"type":"string","maxLength":50,"example":"Kustannuspaikka 1"},"en":{"type":"string","maxLength":50,"example":"Cost center 1"},"sv":{"type":"string","maxLength":50,"example":"Kostnadsställe 1"}}},"description":{"type":"object","description":"Localized description of the dimension.","properties":{"fi":{"type":"string","maxLength":500,"example":"Esimerkkikustannuspaikka"}}},"active":{"type":"boolean","description":"Indicates whether the dimension is in use.","example":true},"valid_from":{"type":["string","null"],"format":"date","example":"2024-01-01"},"valid_to":{"type":["string","null"],"format":"date","example":"2024-12-31"}}}},"schema_14":{"kind":"json-schema","data":{"type":"string","enum":["scheduled_maintenances"]},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"oneOf":[{"title":"Default","type":"object","properties":{"data":{"type":"object","example":{}}},"required":["data"]},{"title":"With scheduled maintenances","type":"object","properties":{"data":{"type":"object","properties":{"scheduled_maintenances":{"type":"array","items":{"$ref":"#/components/schemas/ScheduledMaintenance"}}},"required":["scheduled_maintenances"]}},"required":["data"]}]},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"string","example":"internal_error"},"message":{"type":"string","example":"An unexpected error occurred."}},"required":["code","message"]},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","enum":["active"]},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","enum":["active_employment.employment_group"]},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PayrollEmployeeSimple"}},"meta":{"type":"object","properties":{"next_cursor":{"$ref":"#/components/schemas/NextCursor"}}}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayrollEmployee"}}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DimensionType"}}},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DimensionType"}},"meta":{"type":"object","properties":{"next_cursor":{"$ref":"#/components/schemas/NextCursor"}}}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"string","enum":["dimension_type"]},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DimensionWithDimensionType"}},"meta":{"type":"object","properties":{"next_cursor":{"$ref":"#/components/schemas/NextCursor"}}}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Dimension"}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DimensionWithDimensionType"}}},"id":"schema_27"}},"exampleStore":{},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.fennoa.com/oauth/token","scopes":{}}}},"OAuth2Sandbox":{"id":"OAuth2Sandbox","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to additionally provide the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Company-Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header with the company code of the target company in every request."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://api.sandbox.fennoa.com/oauth/token","scopes":{}}}}},"servers":[{"url":"https://api.fennoa.com/v2","description":"Production server"},{"url":"https://api.sandbox.fennoa.com/v2","description":"Sandbox"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/v2/index.json?download"},{"url":"/_bundle/apis/v2/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fennoa API","description":"⚠️ **Preview Notice:** This API is not live yet. This documentation is for preview purposes only.\n\nEverything you need to integrate Fennoa into your own systems. Read and manage payroll data, employees, and more through a simple REST API.\n"}},"baseSlug":"/apis/v2","routesMapping":{}}