Moneybird API

Projects

Endpointhttps://moneybird.com/api/v2

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.

Returns information about a project › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

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

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/projects/:id:format

shell

Example Responses

{
  "id": "471699893711275108",
  "name": "Project 1",
  "state": "active",
  "budget": 10
}

json

application/json

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.

Deletes a project › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

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

curl --request DELETE \
  --url https://moneybird.com/api/v2/:administration_id/projects/:id:format

shell

Example Responses

No example specified for this content type

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).

Updates a project › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

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

curl --request PATCH \
  --url https://moneybird.com/api/v2/:administration_id/projects/:id:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": {
    "name": "Eagle",
    "budget": 1000
  }
}
'

shell

Example Request Body

{
  "project": {
    "name": "Eagle",
    "budget": 1000
  }
}

json

application/json

Example Responses

{
  "id": "471699893677720673",
  "name": "Eagle",
  "state": "active",
  "budget": 1000
}

json

application/json

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.

List all projects of an administration › path Parameters

administration_id

string | integer · 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

The filter, can be: state:all, state:archived or 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

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

GET/{administration_id}/projects{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/projects:format

shell

Example Responses

[
  {
    "id": "471699893337982017",
    "name": "Project 1",
    "state": "active",
    "budget": 10
  }
]

json

application/json

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.

Creates a new project › path Parameters

administration_id

string | integer · 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

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null

POST/{administration_id}/projects{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/projects:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": {
    "name": "Falcon"
  }
}
'

shell

Example Request Body

{
  "project": {
    "name": "Falcon"
  }
}

json

application/json

Example Responses

{
  "id": "471699893577057369",
  "name": "Falcon",
  "state": "active",
  "budget": null
}

json

application/json

Products Purchase transactions

Returns information about a project

GET

https://moneybird.com/api/v2

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

Returns information about a project.

Returns information about a project › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

id

string | integer · 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.

Deletes a project › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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).

Updates a project › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

id

string | integer · 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}

List all projects of an administration › path Parameters

administration_id

string | integer · 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

The filter, can be: state:all, state:archived or 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

object[]

id

string | integer · 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.

Creates a new project › path Parameters

administration_id

string | integer · 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

id

string | integer · pattern: ^\d+$

A unique record identifier

name

string

state

string · enum

Enum values:

active

archived

budget

integer | null