Moneybird logo
Moneybird API

Projects

Endpoint:https://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 projectpath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • namestring
  • statestring · enum
    Enum values:
    active
    archived
  • budgetinteger | 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 projectpath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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 projectpath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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

  • projectobject

Updates a project Responses

Project updated

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • namestring
  • statestring · enum
    Enum values:
    active
    archived
  • budgetinteger | 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.

List all projects of an administrationpath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · 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 administrationquery Parameters

  • filterstring

    The 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 | string

    The page to fetch, starting at 1.

List all projects of an administration Responses

A list of projects

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • namestring
  • statestring · enum
    Enum values:
    active
    archived
  • budgetinteger | 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 projectpath Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · 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

  • projectobject

Creates a new project Responses

Project created

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • namestring
  • statestring · enum
    Enum values:
    active
    archived
  • budgetinteger | null