{"info":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","description":"

Foresight REST API allows you to access and manipulate data on Foresight end.

API is under development and new features will be added over time.

Overview

Available version: https://foresight-api.bigtime.net/beta/

Authentication

Api use OAuth2.0 authorization. You must authorize Application in order to use API.

Only the \"client credentials\" grant type is available.

Token endpoint:
https://foresight-api.bigtime.net/auth/token/

To learn about OAuth2 you can read one of

many

tutorials on the internet.

Scopes

read - read scope
\n
write - write scope
\n
finance - finance data access
\n

Pagination

Every endpoint which return list is paginated.
Page size is set to 50 items.

sample paginated response

{\n    \"paging\": {\n        \"page\": 1,\n        \"pageSize\": 50,\n        \"totalResults\": 150\n    },\n    \"items\": [...]\n}\n\n

totalResults - total items count

pageSize - max number of objects in one page

page - page numeber

items - array of returned objects

Additional Notes

Please be aware that all requests should end with a slash \"/\"

Rate limits

60 requests/minute

Exception Code 429 if exceeded

\n\n\n

To ensure that BigTime dependencies are properly handled in requests, you must set the X-Enable-Synchronous-Related-Fetch header to True. If this header is missing, the dependency might not yet be available in the system. Enabling this header allows the system to wait for or pull the necessary dependency from BigTime, ensuring smooth and accurate processing of the request.
BigTime related data is fetched based on the SID field. If the SID does not exist or if the request times out (with a timeout period of 30 seconds), an error 424 will occur.

SID and UUID usage

We allow the use of both SID (BigTime related field identifier) and UUID for identification purposes. In many URLs, you can use either an SID or a UUID in a single field, providing flexibility in how resources are accessed. Fields are described as entity_name_sid_or_uuid.
In the case of POST and PATCH requests, it is important to note that you cannot include both SID and UUID simultaneously, as these requests typically require only one form of identifier to avoid conflicts and ensure data integrity.

Exceptions

400 Bad Request: This error occurs when the request is malformed or contains invalid parameters. Ensure all required fields are correctly provided and properly formatted.
\n
404 Not Found: This error indicates that the requested resource could not be found. Verify the URL and ensure the resource exists.
\n
424 Failed Dependency: This error is triggered when the SID does not exist or if there is a timeout in fetching the necessary data from BigTime. Ensure the SID is valid and retry if the error persists.
\n
429 Too Many Requests: This error occurs when too many requests are sent in a given amount of time, exceeding the rate limit. To resolve this, reduce the frequency of requests and try again later. Current Rate Limits: 60 requests/minute
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Pagination","slug":"pagination"},{"content":"Additional Notes","slug":"additional-notes"},{"content":"Rate limits","slug":"rate-limits"},{"content":"BigTime Related","slug":"bigtime-related"}],"owner":"10359207","collectionId":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","publishedId":"2sA2xfYYxC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-08-14T14:37:58.000Z"},"item":[{"name":"Projects' Overheads","item":[{"name":"Scheduled overheads","item":[{"name":"List Scheduled Overheads","id":"d9a74fa9-c01e-4838-9744-fb15d7f24e85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/","description":"

Lists project's overheads in specific projects. You can filter results with optional query params. Results are paginated.

uuid of project

\n","type":"text/plain"},"key":"project_id","value":""},{"disabled":true,"description":{"content":"

sid of project

\n","type":"text/plain"},"key":"project_big_time_sid","value":""},{"disabled":true,"description":{"content":"

represents title field, exact or fragment of title, case insensitive

\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"e7818e78-16ba-4484-9303-88c96d26cce9","name":"List Scheduled Overheads","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/","host":["https://foresight-api.bigtime.net/beta"],"path":["projects_overheads","scheduled",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"page\": 1,\n \"pageSize\": 100,\n \"totalResults\": 150\n },\n \"items\": [\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"Office\",\n \"note\": \"Description of the income\",\n \"money\": {\n \"amount\": 1000,\n \"currency\": \"PLN\" \n },\n \"overhead_type\": \"cost\",\n \"enable_autocommit\": true,\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\"\n },\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"title\": \"Office\",\n \"note\": \"Description of the office\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\" \n },\n \"overhead_type\": \"revenue\",\n \"enable_autocommit\": true,\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\"\n }\n ]\n}"}],"_postman_id":"d9a74fa9-c01e-4838-9744-fb15d7f24e85"},{"name":"Get Scheduled Overhead","id":"10e32d41-a244-4a2f-9bac-04e400696e34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/{overhead_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["projects_overheads","scheduled","{overhead_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[{"disabled":true,"key":"project_id","value":""}],"variable":[]}},"response":[{"id":"6851dc11-f6b6-41a6-bc21-9c8e35fc4d18","name":"Get Scheduled Overhead","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/{{overhead_uuid}}/","host":["https://foresight-api.bigtime.net/beta"],"path":["projects_overheads","scheduled","{{overhead_uuid}}",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"Office\",\n \"note\": \"Description\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"revenue\",\n \"enable_autocommit\": true,\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\"\n}"}],"_postman_id":"10e32d41-a244-4a2f-9bac-04e400696e34"},{"name":"Create Scheduled Overhead","id":"be2f1320-0d0d-4c72-99f3-669d04a73a5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"project_id\": \"769b467b24c140e098dd6a1be6f9c000\",\r\n \"title\": \"Server\",\r\n \"overhead_type\": \"cost\",\r\n \"date\": \"2022-04-03\",\r\n \"money\": {\r\n \"amount\": 120,\r\n \"currency\": \"PLN\"\r\n },\r\n \"enable_autocommit\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/","description":"

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
uuid	Readonly	uuid	UUID of overhead
created_at	Readonly	datetime	Datetime when overhead was created
updated_at	Readonly	datetime	Datetime of last modification on overhead
date	Required	date
project_id	Required	UUID	UUID of a project in which overhead is created
overhead_type	Required	Choice from `cost` or `revenue`
title	Optional	string
note	Optional	string
money	Optional	money object	Set amount
enable_autocommit	Optional	bool, default False	If true, this overhead will be automatically committed on the specified date
realized_in_id	Readonly	UUID	If this overhead is committed UUID of realization will be visible here. Committed overhead can be committed or scheduled.

","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["projects_overheads","scheduled",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"a4926e39-c9ad-4638-b1f6-2da354fa6ca4","name":"Create Scheduled Overhead cost without autocommit","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2022-04-03\",\r\n \"project_id\": \"a7cbe6e9a94d4757ad2fbdb5cd8ce20b\",\r\n \"title\": \"Server\",\r\n \"note\": \"Berlin\",\r\n \"money\": {\r\n \"amount\": 1000,\r\n \"currency\": \"EUR\"\r\n },\r\n \"overhead_type\": \"cost\",\r\n \"enable_autocommit\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T15:48:16.694805Z\",\n \"updated_at\": \"2022-05-10T17:48:16.695199+02:00\",\n \"date\": \"2022-04-03\",\n \"project_id\": \"a7cbe6e9a94d4757ad2fbdb5cd8ce20b\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"Server\",\n \"note\": \"Berlin\",\n \"money\": {\n \"amount\": 1000,\n \"currency\": \"EUR\"\n },\n \"overhead_type\": \"cost\",\n \"enable_autocommit\": false,\n \"realized_in_id\": null\n}"},{"id":"14155754-1073-470b-9c0e-b27a4c057156","name":"Create Scheduled Overhead income with autocommit","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2022-04-03\",\r\n \"project_id\": \"8c434be0144b4202ac3525fd1b1b58fd\",\r\n \"title\": \"Donation\",\r\n \"note\": \"Company 1st\",\r\n \"money\": {\r\n \"amount\": 5000,\r\n \"currency\": \"EUR\"\r\n },\r\n \"overhead_type\": \"revenue\",\r\n \"enable_autocommit\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"6b1cfb58b5c241b38ae14d44f74f117e\",\n \"created_at\": \"2022-05-10T15:54:58.231108Z\",\n \"updated_at\": \"2022-05-10T17:54:58.231830+02:00\",\n \"date\": \"2022-04-03\",\n \"project_id\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"Server\",\n \"note\": \"Berlin\",\n \"money\": {\n \"amount\": 5000,\n \"currency\": \"EUR\"\n },\n \"overhead_type\": \"revenue\",\n \"enable_autocommit\": true,\n \"realized_in_id\": \"00e045cc6c2647619ed408696141da17\"\n}"},{"id":"9f4f1a0e-4847-4c99-ba6d-e10261252dc3","name":"Create Scheduled Overhead minimum requirement","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2022-04-03\",\r\n \"project_id\": {{project_uuid}},\r\n \"overhead_type\": \"revenue\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"uuid\": {{schedule_overhead_uuid}},\n \"created_at\": \"2022-05-10T16:10:00.804928Z\",\n \"updated_at\": \"2022-05-10T18:10:00.805406+02:00\",\n \"date\": \"2022-04-03\",\n \"project_id\": {{project_uuid}},\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": null,\n \"note\": null,\n \"money\": {\n \"amount\": 0,\n \"currency\": \"EUR\"\n },\n \"overhead_type\": \"revenue\",\n \"enable_autocommit\": false,\n \"realized_in_id\": null\n}"}],"_postman_id":"be2f1320-0d0d-4c72-99f3-669d04a73a5e"},{"name":"Edit Scheduled Overhead","id":"79265968-4b47-4fbb-ac61-26b148f8d61f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2022-04-30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/{overhead_uuid}/","description":"

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
uuid	Readonly	uuid	UUID of overhead
created_at	Readonly	datetime	Datetime when overhead was created
updated_at	Readonly	datetime	Datetime of last modification on overhead
date	Optional	date
project_id	Readonly	UUID	UUID of a project in which overhead is created
overhead_type	Readonly	Choice from `cost` or `revenue`
title	Optional	string
note	Optional	string
money	Optional	money object	Set amount
enable_autocommit	Optional	bool, default False	If true, this overhead will be automatically committed on a specified date
realized_in_id	Readonly	UUID	If this overhead is committed UUID of realization will be visible here. Committed overhead can be committed or scheduled.

","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["projects_overheads","scheduled","{overhead_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"fe0098ef-e78d-48a3-a912-bf0b895228bd","name":"Edit Scheduled Overhead","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2022-04-30\",\r\n \"title\": \"New Label\",\r\n \"note\": \"Little note\",\r\n \"money\": {\r\n \"amount\": 2000,\r\n \"currency\": \"EUR\"\r\n },\r\n \"enable_autocommit\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/{{overhead_uuid}}/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T17:20:46.363733Z\",\n \"updated_at\": \"2022-05-10T19:20:46.364259+02:00\",\n \"date\": \"2022-04-30\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"New Label\",\n \"note\": \"Little note\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"EUR\"\n },\n \"overhead_type\": \"cost\",\n \"enable_autocommit\": true,\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\"\n}"}],"_postman_id":"79265968-4b47-4fbb-ac61-26b148f8d61f"},{"name":"Remove Scheduled Overhead","id":"4b570d81-b301-4e09-b23f-9e5a5f43ca55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/{overhead_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["projects_overheads","scheduled","{overhead_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b570d81-b301-4e09-b23f-9e5a5f43ca55"},{"name":"Commit Scheduled Overhead","id":"cdf661dc-b661-4b8b-96a0-a637e70e043a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"date\": \"2022-04-30\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/scheduled/{overhead_uuid}/commit/","description":"

Parameters for method `/commit/`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
uuid	Readonly	uuid	UUID of newly created overhead (settled or not settled)
created_at	Readonly	datetime	Datetime when overhead was created
updated_at	Readonly	datetime	Datetime of last modification on overhead
date	Optional	date
project_id	Readonly	UUID	UUID of a project in which overhead is created
overhead_type	Readonly	Choice from `cost` or `revenue`
title	Optional	string
note	Optional	string
money	Optional	money object	Set amount
enable_autocommit		bool	default is taken from current overhead `autocommit_state`

Description

Scheduled overheads are the one included in the project’s tab in Budget > Scheduled overheads.

Scheduled overheads can be an revenue or a cost.

Scheduled overheads can be automatically committed - at the date of commit new overhead is created which can have status as committed or scheduled, depending on autocommit_state. When overhead is scheduled for a past date and autocommit is enabled, new overhead (committed) is created which uuid is available in realized_in_id field.

To use overheads in public API finance scope needs to be enabled. It is impossible to use this endpoint without financial scope.

\n","_postman_id":"3f0f7684-e092-4d3e-8557-da97215292e3","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}},{"name":"Committed overheads","item":[{"name":"List Committed Overheads","id":"2b2e49c7-6cb4-41c4-9163-712b295bacea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["projects_overheads","committed",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[{"disabled":true,"description":{"content":"

uuid of project

\n","type":"text/plain"},"key":"project_id","value":""},{"disabled":true,"description":{"content":"

sid of project

\n","type":"text/plain"},"key":"project_big_time_sid","value":""},{"disabled":true,"description":{"content":"

represents title field, exact or fragment of title, case insensitive

\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"522ee7b2-5e97-49d4-a106-dbd07fcb9c08","name":"List Committed Overheads","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/","host":["https://foresight-api.bigtime.net/beta"],"path":["projects_overheads","committed",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"page\": 1,\n \"pageSize\": 100,\n \"totalResults\": 150\n },\n \"items\": [\n {\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"created_at\": \"2022-05-10T09:57:02.067766Z\",\n \"updated_at\": \"2022-05-10T11:57:02.068239+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6b1cfb58b5c241b38ae14d44f74f117e\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"test\",\n \"note\": \"Description\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"revenue\",\n \"planed_in_id\": null,\n \"commit\": false\n },\n {\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"created_at\": \"2022-05-10T09:57:02.067766Z\",\n \"updated_at\": \"2022-05-10T11:57:02.068239+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6b1cfb58b5c241b38ae14d44f74f117e\",\n \"title\": \"cost\",\n \"note\": \"Description\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"cost\",\n \"planed_in_id\": null,\n \"enable_autocommit\": false\n },\n {\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"created_at\": \"2022-05-10T09:57:02.067766Z\",\n \"updated_at\": \"2022-05-10T11:57:02.068239+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6b1cfb58b5c241b38ae14d44f74f117e\",\n \"title\": \"revenue\",\n \"note\": \"Description\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"revenue\",\n \"planed_in_id\": null,\n \"enable_autocommit\": false\n }\n ]\n}"}],"_postman_id":"2b2e49c7-6cb4-41c4-9163-712b295bacea"},{"name":"Get Committed Overhead","id":"ec944cb9-855a-4fc9-9875-9be51965bc48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/{overhead_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["projects_overheads","committed","{overhead_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[{"disabled":true,"key":"project_id","value":""}],"variable":[]}},"response":[{"id":"65800577-e680-49c3-aad4-780538d0125d","name":"Get Committed Overhead","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/{{overhead_uuid}}/","host":["https://foresight-api.bigtime.net/beta"],"path":["projects_overheads","committed","{{overhead_uuid}}",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"23bdd9a0c6cd446886ede7253bcaf165\",\n \"created_at\": \"2022-05-10T09:57:02.067766Z\",\n \"updated_at\": \"2022-05-10T11:57:02.068239+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"2557a7e59c9146f585e43f4a930e9cd1\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"revenue\",\n \"note\": \"Description of revenue\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"revenue\",\n \"planed_in_id\": null,\n \"enable_autocommit\": false\n}"}],"_postman_id":"ec944cb9-855a-4fc9-9875-9be51965bc48"},{"name":"Create Committed Overhead","id":"0413b6e5-9fe0-4f01-8e23-dd7d634324fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"project_id\": \"769b467b24c140e098dd6a1be6f9c000\",\r\n \"title\": \"Server\",\r\n \"overhead_type\": \"cost\",\r\n \"date\": \"2022-04-03\",\r\n \"money\": {\r\n \"amount\": 120,\r\n \"currency\": \"PLN\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/","description":"

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
uuid	Readonly	uuid	UUID of overhead
created_at	Readonly	datetime	Datetime when overhead was created
updated_at	Readonly	datetime	Datetime of last modification on overhead
date	Required	date
project_id	Optional	UUID	UUID of a project in which overhead is created (required if project_big_time_sid is empty)
project_big_time_sid	Optional	sid from BigTime	SID of a project in which overhead is created
overhead_type	Required	Choice from `cost` or `revenue`
title	Optional	string
note	Optional	string
money	Optional	money object	Set amount
planed_in_id	Readonly	uuid	UUID of scheduled overhead if it exists. This filed is not empty when scheduled uuid was committed

","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["projects_overheads","committed",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"18916cc7-f98e-4a2c-9838-c29c637e58d4","name":"Create Committed Overhead minimum requirements","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"project_id\": \"a7cbe6e9a94d4757ad2fbdb5cd8ce20b\",\r\n \"overhead_type\": \"cost\",\r\n \"date\": \"2022-04-03\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"c5beac4bd383402c8107168c73876f31\",\n \"created_at\": \"2022-05-11T08:44:30.586692Z\",\n \"updated_at\": \"2022-05-11T10:44:30.587256+02:00\",\n \"date\": \"2022-04-03\",\n \"project_id\": \"a7cbe6e9a94d4757ad2fbdb5cd8ce20b\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": null,\n \"note\": null,\n \"money\": {\n \"amount\": 0,\n \"currency\": \"EUR\"\n },\n \"overhead_type\": \"cost\",\n \"planed_in_id\": null,\n \"enable_autocommit\": false\n}"},{"id":"38df8daf-ed43-4bfc-8731-a9f4eed82f3b","name":"Create Committed Overhead full option","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"project_id\": {{project_uuid}},\r\n \"overhead_type\": \"cost\",\r\n \"note\":\"Note\",\r\n \"date\": \"2022-04-03\",\r\n \"money\": {\r\n \"amount\": 120,\r\n \"currency\": \"USD\"\r\n },\r\n \"enable_autocommit\":true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"created_at\": \"2022-05-11T09:29:47.042070Z\",\n \"updated_at\": \"2022-05-11T11:29:47.042742+02:00\",\n \"date\": \"2022-04-03\",\n \"project_id\": \"6b1cfb58b5c241b38ae14d44f74f117e\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"title\": \"Server\",\n \"note\": \"Note\",\n \"money\": {\n \"amount\": 120,\n \"currency\": \"USD\"\n },\n \"overhead_type\": \"cost\",\n \"planed_in_id\": null,\n \"enable_autocommit\": true\n}"}],"_postman_id":"0413b6e5-9fe0-4f01-8e23-dd7d634324fe"},{"name":"Edit Committed Overhead","id":"52b290eb-d400-4c91-956d-b7db5fe2a1b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"title\": \"new title\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/projects_overheads/committed/{overhead_uuid}/","description":"

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
uuid	Readonly	uuid	UUID of overhead
created_at	Readonly	datetime	Datetime when overhead was created
updated_at	Readonly	datetime	Datetime of last modification on overhead
date	Op	date
project_id	Readonly	UUID	UUID of a project in which overhead is created
project_big_time_sid	Readonly	integer	SID of a project in which overhead is created
overhead_type	Readonly	Choice from `cost` or `revenue`
title	Optional	string
note	Optional	string
money	Optional	money object	Set amount
planed_in_id	Readonly	uuid	UUID of scheduled overhead if it exists. This filed is not empty when scheduled uuid was committed

Committed overheads are included in the project’s tab in Budget > 'Scheduled Overheads' and 'Actual Overheads'. They are differentiated by boolean flag committed.

Committed overheads can be a revenue or a cost. If committed overhead is created based on the scheduled one, the category (cost/revenue) is the same as scheduled.

To use overheads in public api finance scope needs to be enabled. It is impossible to use this endpoint without financial scope.

\n","_postman_id":"05ce9201-93c9-456e-9fd1-239535c35da5","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}},{"name":"Recurring Overheads","item":[{"name":"List Recurring Scheduled Overheads","id":"97a1a09a-3f28-4f3e-a890-651b3e52c785","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/projects_overheads/recurring/scheduled/","description":"

Lists projects scheduled recurring invoices in organization. You can filter results with optional query params. Results are paginated.

uuid of project

\n","type":"text/plain"},"key":"project_id","value":""},{"disabled":true,"description":{"content":"

sid of project

\n","type":"text/plain"},"key":"project_big_time_sid","value":""},{"disabled":true,"description":{"content":"

represents title field, exact or fragment of title, case insensitive

\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"a85defba-802d-4764-a6eb-7fc06ffa2732","name":"List Scheduled Overheads","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://foresight-api.bigtime.net/beta/projects_overheads/recurring/scheduled/","host":["https://foresight-api.bigtime.net/beta"],"path":["projects_overheads","recurring","scheduled",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"page\": 1,\n \"pageSize\": 100,\n \"totalResults\": 150\n },\n \"items\": [\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"prefix\": \"revenue\",\n \"note\": \"Description of the revenue\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"revenue\",\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\",\n \"scheduled_commit_every_month_day\": \"1\"\n },\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"prefix\": \"cost\",\n \"note\": \"Description of the cost\",\n \"money\": {\n \"amount\": 1000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"cost\",\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\",\n \"scheduled_commit_every_month_day\": \"1\"\n }\n ]\n}"}],"_postman_id":"97a1a09a-3f28-4f3e-a890-651b3e52c785"},{"name":"List Recurring Committed Overheads","id":"87f60118-6e25-4771-ac3e-35fdd07714ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/projects_overheads/recurring/committed/","description":"

Lists projects committed recurring invoices in specific project. You can filter results with optional query params. Results are paginated.

uuid of project

\n","type":"text/plain"},"key":"project_id","value":""},{"disabled":true,"description":{"content":"

sid of project

\n","type":"text/plain"},"key":"project_big_time_sid","value":""},{"disabled":true,"description":{"content":"

represents title field, exact or fragment of title, case insensitive

\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"fa749ee1-606c-4369-ab28-6f6020474c6f","name":"List Committed Overheads","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://foresight-api.bigtime.net/beta/projects_overheads/recurring/committed/","host":["https://foresight-api.bigtime.net/beta"],"path":["projects_overheads","recurring","committed",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"paging\": {\n \"page\": 1,\n \"pageSize\": 100,\n \"totalResults\": 150\n },\n \"items\": [\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"project_big_time_sid\": \"JUHROGWXHJPOBKQGVHFUSQNHPCSUIPQOVDUSWPWRQIBFMBMGPTANNAE\",\n \"prefix\": \"revenue\",\n \"note\": \"Description of the revenue\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"revenue\",\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\",\n \"scheduled_commit_every_month_day\": \"1\"\n },\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"prefix\": \"cost\",\n \"note\": \"Description of the cost\",\n \"money\": {\n \"amount\": 1000,\n \"currency\": \"PLN\"\n },\n \"overhead_type\": \"cost\",\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\",\n \"scheduled_commit_every_month_day\": \"1\"\n }\n ]\n}"}],"_postman_id":"87f60118-6e25-4771-ac3e-35fdd07714ba"}],"id":"3f3b731c-a5f0-4eca-89d5-cd8963f09de3","_postman_id":"3f3b731c-a5f0-4eca-89d5-cd8963f09de3","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}}],"id":"a9f9897b-7a88-4aee-8223-d45b7d96c622","_postman_id":"a9f9897b-7a88-4aee-8223-d45b7d96c622","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}},{"name":"Staffer","item":[{"name":"Avatar","item":[{"name":"Get Avatar","id":"64505424-5437-4268-83f9-31678e43bdca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/avatar/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","avatar",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[],"_postman_id":"64505424-5437-4268-83f9-31678e43bdca"},{"name":"Create Avatar","id":"b7cd788b-c729-4e19-9286-743efe82098a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"PUT","header":[{"key":"Content-Disposition","value":"form-data; filename=avatar.png","type":"text"},{"key":"Content-Type","value":"image/png","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/avatar/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","avatar",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[],"_postman_id":"b7cd788b-c729-4e19-9286-743efe82098a"},{"name":"Remove Avatar","id":"dffccdeb-d96c-4bff-8a84-b9f660420eac","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"DELETE","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/avatar/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","avatar",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[],"_postman_id":"dffccdeb-d96c-4bff-8a84-b9f660420eac"}],"id":"ea0f45fb-b0b2-478e-a00d-78f2b8f257da","description":"

Maximum image size is 2048x2048px which is converted to 256x256px and saved in png format.

\n","_postman_id":"ea0f45fb-b0b2-478e-a00d-78f2b8f257da","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}},{"name":"Contracts","item":[{"name":"List contracts","id":"ac6e1e1c-28eb-44e7-98bb-f04a602dd85c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/contracts/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","contracts",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"46e1a362-ea1f-41d5-b81f-e7d7b2d84cfe","name":"List contracts","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/contracts/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"paging\": {\r\n \"page\": 1,\r\n \"pageSize\": 100,\r\n \"totalResults\": 150\r\n },\r\n \"items\": [\r\n {\r\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\r\n \"start_date\": null,\r\n \"end_date\": null,\r\n \"starts_at\": null, // DEPRECATED, use start_date\r\n \"ends_at\": null, // DEPRECATED, use end_date\r\n \"contract_type\": 1,\r\n \"capacity_monday\": 480,\r\n \"capacity_tuesday\": 480,\r\n \"capacity_wednesday\": 480,\r\n \"capacity_thursday\": 480,\r\n \"capacity_friday\": 480,\r\n \"capacity_saturday\": 0,\r\n \"capacity_sunday\": 0,\r\n \"contract_title\": \"Contract 1\",\r\n \"cost_rate_hourly\": \"100.00\"\r\n }\r\n ]\r\n}"}],"_postman_id":"ac6e1e1c-28eb-44e7-98bb-f04a602dd85c"},{"name":"Get contract","id":"e73f6c86-bc36-4f81-bf76-a32c6a2b5409","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/contracts/{contract_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","contracts","{contract_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"58663eb1-8bec-48a2-88b1-c85cf64c8130","name":"Get contract","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/contracts/{{contract_uuid}}/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":" {\r\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\r\n \"start_date\": null,\r\n \"end_date\": null,\r\n \"starts_at\": null, // DEPRECATED, use start_date\r\n \"ends_at\": null, // DEPRECATED, use end_date\r\n \"contract_type\": 1,\r\n \"capacity_monday\": 480,\r\n \"capacity_tuesday\": 480,\r\n \"capacity_wednesday\": 480,\r\n \"capacity_thursday\": 480,\r\n \"capacity_friday\": 480,\r\n \"capacity_saturday\": 0,\r\n \"capacity_sunday\": 0,\r\n \"contract_title\": \"Contract 2\",\r\n \"cost_rate_hourly\": \"100.00\"\r\n}"}],"_postman_id":"e73f6c86-bc36-4f81-bf76-a32c6a2b5409"},{"name":"Create contract","id":"a747afa0-56f7-4bb4-8616-9632d147a4c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"contract_type\": 1,\r\n \"start_date\": \"2020-03-01\",\r\n \"end_date\": \"2020-05-01\",\r\n \"capacity_monday\": 480,\r\n \"capacity_tuesday\": 480,\r\n \"capacity_wednesday\": 480,\r\n \"capacity_thursday\": 480,\r\n \"capacity_friday\": 480,\r\n \"capacity_saturday\": 0,\r\n \"capacity_sunday\": 0,\r\n \"contract_title\": \"My title\",\r\n \"cost_rate_hourly\": \"120.00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/contracts/","description":"

Create new staffer's contract. Contracts can't overlap.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
contract_type	Readonly	Number, 2 is default	2: Hourly rate
starts_at	Optional	date in ISO format	Date when contrac starts, date can be set to `none`
ends_at	Optional	date in ISO format	Date when cotnract ends, date can be set to `none`
capacity_monday	Optional	Number	Capacity for contract on monday, in minutes
capacity_tuesday	Optional	Number	Capacity for contract on tuesday, in minutes
capacity_wednesday	Optional	Number	Capacity for contract on wednesday, in minutes
capacity_thursday	Optional	Number	Capacity for contract on thursday, in minutes
capacity_friday	Optional	Number	Capacity for contract on friday, in minutes
capacity_saturday	Optional	Number	Capacity for contract on saturday, in minutes
capacity_sunday	Optional	Number	Capacity for contract on sunday, in minutes
contract_title	Optional	String	Title of the contract

Finance Scope Fields only.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
cost_rate_hourly	Optional	Number	Hour cost of staffer

Update staffer's contract.

Contracts can't overlap.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
contact_type	Readonly	Number, 2 is default	2: Hourly rate
starts_at	Optional	date in ISO format	Date when contrac starts, date can be set to `none`
ends_at	Optional	date in ISO format	Date when cotnract ends, date can be set to `none`
capacity_monday	Optional	Number	Capacity for contract on monday, in minutes
capacity_tuesday	Optional	Number	Capacity for contract on tuesday, in minutes
capacity_wednesday	Optional	Number	Capacity for contract on wednesday, in minutes
capacity_thursday	Optional	Number	Capacity for contract on thursday, in minutes
capacity_friday	Optional	Number	Capacity for contract on friday, in minutes
capacity_saturday	Optional	Number	Capacity for contract on saturday, in minutes
capacity_sunday	Optional	Number	Capacity for contract on sunday, in minutes
contract_title	Optional	String	Title of the contract

Finance Scope Fields only.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Characteristic	Type	Description
cost_rate_hourly	Optional	Number	Hour cost of staffer

Remove employee's contract

Endpoints for staffer's capacities. Capacities can't overlap.

Some fields (Finance data) may be only available when finance scope is enabled.

\n","event":[{"listen":"prerequest","script":{"id":"0d5d24cb-85fa-430a-963b-53bae8114ef0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"db969245-e4f5-4445-92ba-8f52e41bfc1b","type":"text/javascript","exec":[""]}}],"_postman_id":"4ddd4bca-ad53-42d2-9823-1ba4a7b1972b","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}},{"name":"Entries (Skills)","item":[{"name":"List staffer's entries","id":"8abbbf3e-400a-4b42-a5c9-6163432e4e4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/entries/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{{staffer_sid_or_uuid}}","entries",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"63879a12-5fa2-4f27-b45c-4597f0a54ab3","name":"List staffer's entries","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/entries/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\r\n \"level\": 3,\r\n \"skill\": {\r\n \"name\": \"C#\",\r\n \"uuid\": \"6d0ab59e1348426d8d85746d452438cb\",\r\n \"ancestors_list\": [\r\n {\r\n \"uuid\": \"165100162d6f4423bd49e0382859fe88\",\r\n \"name\": \"Technical skills\"\r\n },\r\n {\r\n \"uuid\": \"23bdd9a0c6cd446886ede7253bcaf165\",\r\n \"name\": \"C\"\r\n }\r\n ]\r\n }\r\n }\r\n]"}],"_postman_id":"8abbbf3e-400a-4b42-a5c9-6163432e4e4f"},{"name":"Get staffer's entry","id":"3753a7f6-7b74-44db-9a93-5149b8767130","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/entries/{entry_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","entries","{entry_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"9ec62fda-29eb-483f-ac82-b05a46f2b385","name":"Get staffer's entrie","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/entries/{{entry_uuid}}/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\r\n \"level\": 3,\r\n \"skill\": {\r\n \"name\": \"C#\",\r\n \"uuid\": \"6d0ab59e1348426d8d85746d452438cb\",\r\n \"ancestors_list\": [\r\n {\r\n \"uuid\": \"165100162d6f4423bd49e0382859fe88\",\r\n \"name\": \"Technical skills\"\r\n },\r\n {\r\n \"uuid\": \"23bdd9a0c6cd446886ede7253bcaf165\",\r\n \"name\": \"C\"\r\n }\r\n ]\r\n }\r\n}"}],"_postman_id":"3753a7f6-7b74-44db-9a93-5149b8767130"},{"name":"Create staffer's entries","id":"43ed541a-8d53-4db6-974c-ced4be876698","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"skill_id\": \"e0a41b03e8e54b47acf7f705f61c4432\",\r\n \"level\": 3\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/entries/","description":"

Create new employee entry (skill with level).

Parameters

skill_id*
id of skill
\n
level*
level of knowlage from 0 to 4
\n

* required

Edit employees entry (skill with level).

Parameters

skill_id
id of skill
\n
level
level of knowlage from 0 to 4
\n

Representation of staffer's skills and skill levels. Levels are 0-4.

\n","_postman_id":"fbda9e09-016a-4817-be23-052b25c690a1","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}},{"name":"Experiences","item":[{"name":"List staffer's experiences","id":"8e085eb0-6327-458d-b41d-f4a917f4c25e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/experiences/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","experiences",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"e802d2e6-5198-42b7-afb3-adc1fe46d069","name":"List staffer's experiences","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/experiences/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"position\": \"Fullstack Developer\",\n \"project_name\": \"Project 2\",\n \"industry\": \"Industry 2\",\n \"region\": \"Poland\",\n \"duration\": 12,\n \"work_start\": null,\n \"work_end\": null,\n \"desc\": \"This is a description\",\n \"skills\": [\n \"6b1cfb58b5c241b38ae14d44f74f117e\"\n ],\n \"skills_options\": [\n {\n \"name\": \"C#\",\n \"uuid\": \"00e045cc6c2647619ed408696141da17\",\n \"path\": \"Technical skills/C\",\n \"ancestors\": [\n \"2da6415a48904e13b827a516e6b2499e\",\n \"6d0ab59e1348426d8d85746d452438cb\"\n ]\n }\n ]\n }\n]"}],"_postman_id":"8e085eb0-6327-458d-b41d-f4a917f4c25e"},{"name":"Get staffer's experiences","id":"5fe4af18-5505-4646-9b44-ce5f3d07610f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/experiences/{experience_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","experiences","{experience_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"3b759a1f-96dc-4c77-8a51-f11661ee2f02","name":"Get staffer's experiences","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/experiences/{{experience_uuid}}/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\r\n \"position\": \"Fullstack Developer\",\r\n \"project_name\": \"Project 2\",\r\n \"industry\": \"Industry 2\",\r\n \"region\": \"Poland\",\r\n \"duration\": 12,\r\n \"work_start\": null,\r\n \"work_end\": null,\r\n \"desc\": \"This is a description\",\r\n \"skills\": [\r\n \"6b1cfb58b5c241b38ae14d44f74f117e\"\r\n ],\r\n \"skills_options\": [\r\n {\r\n \"name\": \"C#\",\r\n \"uuid\": \"00e045cc6c2647619ed408696141da17\",\r\n \"path\": \"Technical skills/C\",\r\n \"ancestors\": [\r\n \"2da6415a48904e13b827a516e6b2499e\",\r\n \"6d0ab59e1348426d8d85746d452438cb\"\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"5fe4af18-5505-4646-9b44-ce5f3d07610f"},{"name":"Create staffer's experiences","id":"6734aadb-004f-4adb-bbdb-14e68a1048fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"position\": \"Developer\",\r\n \"project_name\": \"3D chess game\",\r\n \"industry\": \"Lichess\",\r\n \"region\": \"\",\r\n \"duration\": 12,\r\n \"work_start\": null,\r\n \"work_end\": null,\r\n \"desc\": \"\",\r\n \"skills\": [\r\n \"9869508f418142d89f5a6a8cf440d6aa\",\r\n \"4637efb5f9e74b98b28bef1ef3d08b8b\",\r\n \"52b6202a77d0459f84adcc8d5c6e97db\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/experiences/","description":"

Create new employees experience

Parameters

position
Default is Developer
project_name
Name of a project
industry
Name of an industry
region
Name of a region
duration
duration in months, duration can not be used together with work_start and work_end
work_start
Start of an experience in ISO-8601 format, can be used when duration is not specified
work_end
End of an experience in ISO-8601 format. When will be not specified it would be treated as \"Present\". Can be used when duration is not specified
desc
Description of an experience
skills_options
readonly - detailed info about skills
skills
List of skills' ids

Edit employees experience

Parameters

position
Default is Developer
\n
project_name
Name of a project
\n
industry
Name of an industry
\n
region
Name of a region
\n
duration
duration in months, duration can not be used together with work_start and work_end
\n
work_start
Start of an experience in ISO-8601 format, can be used when duration is not specified
\n
work_end
End of an experience in ISO-8601 format. When will be not specified it would be treated as \"Present\". Can be used when duration is not specified
\n
desc
_Description of an experience
\n
skills
List of skills' ids
\n

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","experiences","{experience_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"031af159-4fe2-4d6f-b778-24169263aa30","name":"Edit staffer's experiences","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"position\": \"Backend Developer\",\r\n \"project_name\": \"Project 3\",\r\n \"industry\": \"Industry 3\",\r\n \"region\": \"Germany\",\r\n \"duration\": null,\r\n \"work_start\": \"2020-01-01\",\r\n \"work_end\": \"2020-12-31\",\r\n \"desc\": \"This a new description\",\r\n \"skills\": [\"6b1cfb58b5c241b38ae14d44f74f117e\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_id}}/experiences/{{experience_id}}/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\r\n \"position\": \"Backend Developer\",\r\n \"project_name\": \"Project 3\",\r\n \"industry\": \"Industry 3\",\r\n \"region\": \"Germany\",\r\n \"duration\": null,\r\n \"work_start\": \"2020-01-01\",\r\n \"work_end\": \"2020-12-31\",\r\n \"desc\": \"This a new description\",\r\n \"skills\": [\r\n \"6b1cfb58b5c241b38ae14d44f74f117e\"\r\n ],\r\n \"skills_options\": [\r\n {\r\n \"name\": \"C#\",\r\n \"uuid\": \"00e045cc6c2647619ed408696141da17\",\r\n \"path\": \"Technical skills/C\",\r\n \"ancestors\": [\r\n \"2da6415a48904e13b827a516e6b2499e\",\r\n \"6d0ab59e1348426d8d85746d452438cb\"\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"853f12b6-a0e4-45c6-9444-6454467c1104"},{"name":"Remove staffer's experiences","id":"7e420c77-4439-4bd8-9c8d-2ebc140bd23e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/experiences/{experience_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","experiences","{experience_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e420c77-4439-4bd8-9c8d-2ebc140bd23e"}],"id":"0a5e7a2c-a07d-4697-9760-ca3b9f8d4511","_postman_id":"0a5e7a2c-a07d-4697-9760-ca3b9f8d4511","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}}},{"name":"Education","item":[{"name":"List staffer's education","id":"236a4de3-36c6-4e84-bdb7-b79835598fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/education/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","education",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"cafde43b-2de2-4654-af56-2f77b4b3b642","name":"List staffer's education","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/education/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"uuid\": \"165100162d6f4423bd49e0382859fe88\",\r\n \"name\": \"UCLA\",\r\n \"degree\": \"PhD\",\r\n \"start\": \"01-09-2015\",\r\n \"end\": \"31-05-2021\",\r\n \"description\": \"PhD in computer science\"\r\n }\r\n \r\n]"}],"_postman_id":"236a4de3-36c6-4e84-bdb7-b79835598fd2"},{"name":"Get staffer's education","id":"b83c6342-aecc-4342-8233-6d64a94325ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/education/{education_uuid}/","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"client_authentication","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""},{"key":"clientId","value":""},{"key":"scope","value":""},{"key":"authUrl","value":""},{"key":"useBrowser","value":""},{"key":"tokenName","value":""},{"key":"clientSecret","value":""},{"key":"tokenType","value":""}]},"isInherited":true,"source":{"_postman_id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","id":"94cf7ace-02e5-46bd-9ceb-c3d5fc1eb030","name":"Foresight","type":"collection"}},"urlObject":{"path":["staffers","{staffer_sid_or_uuid}","education","{education_uuid}",""],"host":["https://foresight-api.bigtime.net/beta"],"query":[],"variable":[]}},"response":[{"id":"690f68cb-f6f1-40a3-a751-229a00878e9a","name":"Get staffer's education","originalRequest":{"method":"GET","header":[],"url":"https://foresight-api.bigtime.net/beta/staffers/{{staffer_sid_or_uuid}}/education/{{education_uuid}}/"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":" {\r\n \"uuid\": \"165100162d6f4423bd49e0382859fe88\",\r\n \"name\": \"UCLA\",\r\n \"degree\": \"PhD\",\r\n \"start\": \"01-09-2015\",\r\n \"end\": \"31-05-2021\",\r\n \"description\": \"PhD in computer science\"\r\n }"}],"_postman_id":"b83c6342-aecc-4342-8233-6d64a94325ba"},{"name":"Create staffer's education","id":"fe248290-88e8-435b-bcfd-46156b6ae0b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"UCLA\",\r\n \"degree\": \"Master's\",\r\n \"start\": \"31-05-2020\",\r\n \"end\": null,\r\n \"description\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://foresight-api.bigtime.net/beta/staffers/{staffer_sid_or_uuid}/education/","description":"

Create new employee's education

Parameters

name
Name of an institution
\n
degree
\n
start
Start date in MM-YYYY format
\n
end
End date in MM-YYYY format
\n
description
duration in months, duration can not be used together with work_start and work_end
\n

StartFragment

Edit employee's education

Parameters

name
Name of an institution
degree
start
Start date in MM-YYYY format
end
End date in MM-YYYY format
description
duration in months, duration can not be used together with work_start and work_end

EndFragment

Related object	Behavior
staffer	XOR-like: UUID or BigTime SID must be set, but not both
project	XOR-like: UUID or BigTime SID must be set, but not both
project role	NAND-like: UUID or BigTime SID can be set, but not both. Default value is given if neither of them is set (or both are `null`)
project task (valid only if TaskBasedResourcing feature is enabled)	NAND-like: UUID or BigTime SID can be set, but not both. Default value is given if neither of them is set (or both are `null`)

Name	Options	Type	Description
scheduling_mode	Optional	integer from range [0, 4], default 1	Modes to decide which utilization type should be used. Available options: 0 - No utilization 1 - Capacity 2 - Time frame 3 - Weekday 4 - Weekday by capacity
scheduling_time_frame	Semi-Optional	integer from range [0, 3], default 0	Option only available when _scheduling_mode=2 (Time Frame),_Available options: 0 - Day 1 - Week 2 - Month 3 - Assignment
scheduled_work_per_time_frame	Semi-Optional	integer [minutes], default 480	Option only available when scheduling_mode=2 (Time Frame), field say how many work in minutes in specific timeframe will be
work_on_monday	Semi-Optional	boolean, default True	Option only available when _scheduling_mode=1 or 2 (Capacity or Time Frame),__Value tells if work is scheduled for this day._If value is false Monday would not be included in this assignment scheduling
work_on_tuesday	Semi-Optional	boolean, default True	Option only available when _scheduling_mode=1 or 2 (Capacity or Time Frame),__Value tells if work is scheduled for this day._If value is false Tuesday would not be included in this assignment scheduling
work_on_wednesday	Semi-Optional	boolean, default True	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is false Wednesday would not be included in this assignment scheduling
work_on_thursday	Semi-Optional	boolean, default True	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is false Thursday would not be included in this assignment scheduling
work_on_friday	Semi-Optional	boolean, default True	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is false Friday would not be included in this assignment scheduling
work_on_saturday	Semi-Optional	boolean, default False	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is true Saturday would be included in this assignment scheduling
work_on_sunday	Semi-Optional	boolean, default False	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is true Sunday would be included in this assignment scheduling
adjust_scheduling_to_time_off	Semi-Optional	boolean, default True	Scheduled utilization will be adjusted based on existing time-offs in this assignment. Option only available when *scheduling_mode=2 or 3 (Time Frame or Weekday)
reduce_utilization_by_time_off	Semi-Optional	boolean, default true	Option only available when _scheduling_mode=2 (Time Frame),_Available options: `true = Reduce utilization by time off` `false = Schedule utilization outside time off`
adjust_scheduling_to_public_holidays	Semi-Optional	boolean, default true	Option only available when *scheduling_mode=2 or 3 (Time Frame or Weekday)
reduce_utilization_by_public_holidays	Semi-Optional	boolean, default true	Option only available when *scheduling_mode=2 (Time Frame) `true = Reduce utilization by public holidays` `false = Schedule utilization outside public holidays`
capacity_based_load	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=1 (Capacity)
assign_leftover_billable_capacity	Semi-Optional	boolean	Option only available when *scheduling_mode=1 (Capacity)
work_per_monday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_tuesday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_wednesday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_thursday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_friday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_saturday	Semi-Optional	integer, default 0[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_sunday	Semi-Optional	integer, default 0[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_by_capacity_per_monday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_tuesday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_wednesday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_thursday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_friday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_saturday	Semi-Optional	integer, default 0 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_sunday	Semi-Optional	integer, default 0 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
actual_work	Readonly	decimal	Total input hours in minutes in this assignment, data based on time entries
scheduled_work	Readonly	decimal	Total scheduled minutes based on defined utilization and assignment date range
daily_data	Readonly	object	Params: start - date of first day of assignment or date of first logged time entry if time entry was created for date before assignment started. end - date of last day of assignment or date of last logged time entry if time entry was created for date after assignment ended. tracked - list of integers where each value is time tracked in minutes for each day between start and end. scheduled - list of integers where each value is time scheduled in minutes for each day between start and end. Start and end can be wider than range of assignment because time entry can be created outside of assignment dates ranges. If time entry is created outside of assignment range scheduled list is filled with 0 values for corresponding days
off_hours_work	Optional	boolean, default False	Specify if assignment is Off-Hours Work
only_billable_work	Optional	boolean, default False	Tells if only billable work can be logged in this assignment
reduce_billable_capacity	Optional	boolean, default False	Reduce billable capacity

Name	Options	Type	Description
financial_scheduled_total_revenue	Readonly	money object	Revenue calculated based on scheduled time and hour price
financial_scheduled_total_cost	Readonly	money object	Cost calculated based on scheduled time and budget mode in Organization currency
financial_total_actual_revenue	Readonly	money object	Revenue calculated based on logged time in assignment's worklogs and hour price in Client currency
financial_total_actual_cost	Readonly	money object	Cost calculated based on logged time in assignment's worklogs and budget mode in Organization currency
financial_actual_work_for_cost	Readonly	integer	Total logged minutes in this assignment
financial_avg_cost_rate	Semi-Optional	decimal	Shows assigned staffer's Cost Rate
financial_avg_bill_rate	Readonly	money object	Shows assigned staffer's Bill Rate
financial_actual_work_for_revenue	Readonly	integer	Total logged minutes in this assignment

Related object	Behavior
project role	NAND-like: UUID or BigTime SID can be set, but not both. Default value is given if neither of them is set (or both are `null`)
project task (valid only if TaskBasedResourcing feature is enabled)	NAND-like: UUID or BigTime SID can be set, but not both. Default value is given if neither of them is set (or both are `null`)

Name	Options	Type	Description
scheduling_mode	Optional	integer from range [0, 4], default 1	Modes to decide which utilization type should be used. Available options: 0 - No utilization 1 - Capacity 2 - Time frame 3 - Weekday 4 - Weekday by capacity
scheduling_time_frame	Semi-Optional	integer from range [0, 3], default 0	Option only available when _scheduling_mode=2 (Time Frame),_Available options: 0 - Day 1 - Week 2 - Month 3 - Assignment
scheduled_work_per_time_frame	Semi-Optional	integer [minutes], default 480	Option only available when scheduling_mode=2 (Time Frame), field say how many work in minutes in specific timeframe will be
work_on_monday	Semi-Optional	boolean, default True	Option only available when _scheduling_mode=1 or 2 (Capacity or Time Frame),__Value tells if work is scheduled for this day._If value is false Monday would not be included in this assignment scheduling
work_on_tuesday	Semi-Optional	boolean, default True	Option only available when _scheduling_mode=1 or 2 (Capacity or Time Frame),__Value tells if work is scheduled for this day._If value is false Tuesday would not be included in this assignment scheduling
work_on_wednesday	Semi-Optional	boolean, default True	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is false Wednesday would not be included in this assignment scheduling
work_on_thursday	Semi-Optional	boolean, default True	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is false Thursday would not be included in this assignment scheduling
work_on_friday	Semi-Optional	boolean, default True	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is false Friday would not be included in this assignment scheduling
work_on_saturday	Semi-Optional	boolean, default False	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is true Saturday would be included in this assignment scheduling
work_on_sunday	Semi-Optional	boolean, default False	Option only available when scheduling_mode=1 or 2 (Capacity or Time Frame), Value tells if work is scheduled for this day.If value is true Sunday would be included in this assignment scheduling
adjust_scheduling_to_time_off	Semi-Optional	boolean, default True	Scheduled utilization will be adjusted based on existing time-offs in this assignment. Option only available when *scheduling_mode=2 or 3 (Time Frame or Weekday)
reduce_utilization_by_time_off	Semi-Optional	boolean, default true	Option only available when _scheduling_mode=2 (Time Frame),_Available options: `true = Reduce utilization by time off` `false = Schedule utilization outside time off`
adjust_scheduling_to_public_holidays	Semi-Optional	boolean, default true	Option only available when *scheduling_mode=2 or 3 (Time Frame or Weekday)
reduce_utilization_by_public_holidays	Semi-Optional	boolean, default true	Option only available when *scheduling_mode=2 (Time Frame) `true = Reduce utilization by public holidays` `false = Schedule utilization outside public holidays`
capacity_based_load	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=1 (Capacity)
assign_leftover_billable_capacity	Semi-Optional	boolean	Option only available when *scheduling_mode=1 (Capacity)
work_per_monday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_tuesday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_wednesday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_thursday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_friday	Semi-Optional	integer, default 480[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_saturday	Semi-Optional	integer, default 0[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_per_sunday	Semi-Optional	integer, default 0[minutes]	Representing how many minutes will be scheduled for this weekday. Option only available when *scheduling_mode=3 (Weekday)
work_by_capacity_per_monday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_tuesday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_wednesday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_thursday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_friday	Semi-Optional	integer, default 100 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_saturday	Semi-Optional	integer, default 0 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
work_by_capacity_per_sunday	Semi-Optional	integer, default 0 percent	Option only available when *scheduling_mode=4 (Weekday by capacity). Represents percent of used capacity for this assignment in this day.
actual_work	Readonly	decimal	Total input hours in minutes in this assignment, data based on time entries
scheduled_work	Readonly	decimal	Total scheduled minutes based on defined utilization and assignment date range
daily_data	Readonly	object	Params: start - date of first day of assignment or date of first logged time entry if time entry was created for date before assignment started. end - date of last day of assignment or date of last logged time entry if time entry was created for date after assignment ended. tracked - list of integers where each value is time tracked in minutes for each day between start and end. scheduled - list of integers where each value is time scheduled in minutes for each day between start and end. Start and end can be wider than range of assignment because time entry can be created outside of assignment dates ranges. If time entry is created outside of assignment range scheduled list is filled with 0 values for corresponding days
off_hours_work	Optional	boolean, default False	Specify if assignment is Off-Hours Work
only_billable_work	Optional	boolean, default False	Tells if only billable work can be logged in this assignment
reduce_billable_capacity	Optional	boolean, default False	Reduce billable capacity

Related object	Behavior
department	XOR-like: UUID or BigTime SID must be set, but not both
certificate	list of UUIDS
cost_center	cost centers 1,2,3 identified by SID
project	XOR-like: UUID or BigTime SID must be set, but not both
role	XOR-like: UUID or BigTime SID must be set, but not both
project task (valid only if TaskBasedResourcing feature is enabled)	NAND-like: UUID or BigTime SID can be set, but not both. Default value is given if neither of them is set (or both are `null`)

Overview

Authentication

Scopes

Pagination

Additional Notes

Rate limits

BigTime Related

Fetch related Header

SID and UUID usage

Exceptions

Parameters

Parameters

Parameters for method /commit/

Description

Parameters

Parameters

Create new staffer's contract. Contracts can't overlap.

Finance Scope Fields only.

Update staffer's contract.

Contracts can't overlap.

Finance Scope Fields only.

Create new employee entry (skill with level).

Parameters

Edit employees entry (skill with level).

Parameters

Create new employees experience

Parameters

Edit employees experience

Parameters

Create new employee's education

Parameters

Edit employee's education

Parameters

Create new employee's certificate

Parameters

Edit employee's certificate

Parameters

Edit staffer's information

Parameters

GET staffer daily capacity

Parameters

Parameters

Parameters Table

Utilization Parameters

Financial Parameters (only available in application with financial scope)

Parameters

Parameters table

Utilization Parameters

Financial Parameters (only available in application with financial scope)

Parameters

Parameters table

Utilization Parameters

Financial Parameters (only available in application with financial scope)

Parameters

Utilization Parameters

Financial Parameters (only available in application with financial scope)

Parameters

Create new skill

Parameters

Edit skill

Parameters

Parameters for method `/commit/`