Projects

Projects allow you to group time entries and financials for specific projects you are working on.

Returns information about a project

GET

https://moneybird.com/api/v2

/{administration_id}/projects/{id}{format}

Returns information about a project.

Required scope(s)

settings

Returns information about a project › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Returns information about a project › Responses

A project

project_response

id

identifier · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

Deletes a project

DELETE

https://moneybird.com/api/v2

/{administration_id}/projects/{id}{format}

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.

Required scope(s)

settings

Deletes a project › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Deletes a project › Responses

Project deleted

No data returned

Updates a project

PATCH

https://moneybird.com/api/v2

/{administration_id}/projects/{id}{format}

Updates a project. Requires permission to settings. Requires a unique name within the administration (if name is provided).

Required scope(s)

settings

Updates a project › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

identifier · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Updates a project › Request Body

object

Updates a project › Responses

Project updated

project_response

id

identifier · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

List all projects of an administration

GET

https://moneybird.com/api/v2

/{administration_id}/projects{format}

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.

Required scope(s)

settings

List all projects of an administration › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all projects of an administration › query Parameters

filter

string

Filters are key:value terms separated by commas (e.g. state:active). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:

Filter	Type	Default	Description
state	`String`	`active`	`all`, `active` or `archived`. Combine values with a pipe, e.g. `state:active

Default: state:active

per_page

integer | string · min: 1 · max: 100 · pattern: ^\d+$

Amount of projects per page, default: 25

page

integer | string

The page to fetch, starting at 1.

List all projects of an administration › Responses

A list of projects

project_response[]

project_response

id

identifier · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

Creates a new project

POST

https://moneybird.com/api/v2

/{administration_id}/projects{format}

Creates a new project. Requires a unique name within the administration.

Required scope(s)

settings

Creates a new project › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Creates a new project › Request Body

object

Creates a new project › Responses

Project created

project_response

id

identifier · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

Products Purchase transactions