Moneybird API

Products

Endpoint:https://moneybird.com/api/v2

Products are the goods or services you sell. You can add them to invoices and estimates.

Returns information about a product based on the identifier

GET

https://moneybird.com/api/v2

/{administration_id}/products/identifier/{identifier}{format}

Finds the product by the identifier field of the product.

Returns information about a product based on the identifier › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
identifierstring · required
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 product based on the identifier › Responses

A product

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Create online sales link

POST

https://moneybird.com/api/v2

/{administration_id}/products/{id}/sales_link{format}

This call generates an online sales link, and allows pre-setting the contact for a checkout page. The link is valid for one hour

Create online sales link › path 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

Create online sales link › query Parameters

contact_idstring | integer · pattern: ^\d+$
A unique record identifier

Create online sales link › Responses

A sales link

string

Returns information about a product

GET

https://moneybird.com/api/v2

/{administration_id}/products/{id}{format}

Returns information about a product.

Returns information about a product › path 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 product › Responses

A product

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Deletes a product

DELETE

https://moneybird.com/api/v2

/{administration_id}/products/{id}{format}

Deletes a product if it has no dependencies. If the product has associated details, subscription products, orders, or subscription templates, deletion is blocked and the product will be deactivated instead. If the product has active subscriptions or subscription templates, deactivation is blocked and an error is returned.

Deletes a product › path 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 product › Responses

Product deleted

No data returned

Updates a product

PATCH

https://moneybird.com/api/v2

/{administration_id}/products/{id}{format}

Updates a product.

Updates a product › path 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 product › Request Body

productobject

Updates a product › Responses

Product updated

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

List all products of an administration

GET

https://moneybird.com/api/v2

/{administration_id}/products{format}

Returns a paginated list of products in the administration. Each page contains 10 products. You can use the page parameter to fetch the next page of products.

List all products of an administration › path 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 products of an administration › query Parameters

querystring
Allows filtering by product name.
pageinteger | string
The page to fetch, starting at 1.
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$
currencystring
ISO three-character currency code, e.g. EUR or USD.

List all products of an administration › Responses

A list of products

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Creates a new product

POST

https://moneybird.com/api/v2

/{administration_id}/products{format}

Creates a new product.

Creates a new product › path 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 product › Request Body

productobject

Creates a new product › Responses

Product created

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Payments Projects

Moneybird API

Products

Endpoint:https://moneybird.com/api/v2

Products are the goods or services you sell. You can add them to invoices and estimates.

Returns information about a product based on the identifier

GET

https://moneybird.com/api/v2

/{administration_id}/products/identifier/{identifier}{format}

Finds the product by the identifier field of the product.

Returns information about a product based on the identifier › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
identifierstring · required
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 product based on the identifier › Responses

A product

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Create online sales link

POST

https://moneybird.com/api/v2

/{administration_id}/products/{id}/sales_link{format}

This call generates an online sales link, and allows pre-setting the contact for a checkout page. The link is valid for one hour

Create online sales link › path 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

Create online sales link › query Parameters

contact_idstring | integer · pattern: ^\d+$
A unique record identifier

Create online sales link › Responses

A sales link

string

Returns information about a product

GET

https://moneybird.com/api/v2

/{administration_id}/products/{id}{format}

Returns information about a product.

Returns information about a product › path 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 product › Responses

A product

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Deletes a product

DELETE

https://moneybird.com/api/v2

/{administration_id}/products/{id}{format}

Deletes a product › path 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 product › Responses

Product deleted

No data returned

Updates a product

PATCH

https://moneybird.com/api/v2

/{administration_id}/products/{id}{format}

Updates a product.

Updates a product › path 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 product › Request Body

productobject

Updates a product › Responses

Product updated

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

List all products of an administration

GET

https://moneybird.com/api/v2

/{administration_id}/products{format}

Returns a paginated list of products in the administration. Each page contains 10 products. You can use the page parameter to fetch the next page of products.

List all products of an administration › path 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 products of an administration › query Parameters

querystring
Allows filtering by product name.
pageinteger | string
The page to fetch, starting at 1.
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$
currencystring
ISO three-character currency code, e.g. EUR or USD.

List all products of an administration › Responses

A list of products

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Creates a new product

POST

https://moneybird.com/api/v2

/{administration_id}/products{format}

Creates a new product.

Creates a new product › path 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 product › Request Body

productobject

Creates a new product › Responses

Product created

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
descriptionstring | null
titlestring | null
identifierstring | null
pricestring
currencystring
frequencyinteger | null
frequency_typestring | null · enum
Enum values:
day
week
month
quarter
year
tax_rate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer · pattern: ^\d+$
A unique record identifier
created_atstring · date-time
updated_atstring · date-time

Payments Projects