Projects allow you to group time entries and financials for specific projects you are working on.
Returns information about a project
Returns information about a project.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A project
idstring | integer · pattern:^\d+$A unique record identifier
namestringstatestring · enumEnum values:activearchivedbudgetinteger | null
Deletes a project
Deletes a project. When there are no linked entities (sales invoices, estimates, etc.) the project is deleted. When there are linked entities, the project gets the state archived.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Project deleted
Updates a project
Updates a project. Requires permission to settings. Requires a unique name within the administration (if name is provided).
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Project updated
idstring | integer · pattern:^\d+$A unique record identifier
namestringstatestring · enumEnum values:activearchivedbudgetinteger | null
List all projects of an administration
Returns a paginated list of projects in the administration. Each page contains 25 projects. You can use the page parameter to fetch the next page of projects. It returns the active projects when no filter is applied.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstringThe filter, can be: state:all, state:archived or state:active
per_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$Amount of projects per page, default: 25
pageinteger | stringThe page to fetch, starting at 1.
Responses
A list of projects
idstring | integer · pattern:^\d+$A unique record identifier
namestringstatestring · enumEnum values:activearchivedbudgetinteger | null
Creates a new project
Creates a new project. Requires a unique name within the administration.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Project created
idstring | integer · pattern:^\d+$A unique record identifier
namestringstatestring · enumEnum values:activearchivedbudgetinteger | null