Moneybird API

Recurring sales invoices

Endpointhttps://moneybird.com/api/v2

Recurring sales invoices are templates for invoices that are sent automatically at a recurring interval.

List all IDs and versions

GET

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/synchronization{format}

Returns all recurring sales invoices in the administration. The list contains the invoice id and the version of the recurring invoice. Check if the version of the recurring invoice is newer than the version you have stored locally, use the POST variant for fetching recurring invoices with the given IDs.

List all IDs and versions › 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 IDs and versions › query Parameters

filter

string

List all IDs and versions › Responses

200

IDs and versions of records

object[]

id

integer | string

version

integer | string

GET/{administration_id}/recurring_sales_invoices/synchronization{format}

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

shell

Example Responses

[
  {
    "id": "471699745934411373",
    "version": 1764067954
  }
]

json

application/json

Fetch recurring sales invoices with given IDs

POST

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/synchronization{format}

Given a list of recurring sales invoice IDs, returns the details of the recurring invoices. Returns a maximum of 100 recurring invoices, even if more IDs are provided.

Fetch recurring sales invoices with given IDs › 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

Fetch recurring sales invoices with given IDs › Request Body

ids

(integer | string)[] · required

Fetch recurring sales invoices with given IDs › Responses

A list of recurring sales invoices

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

invoice_date

string · date

last_date

string | null · date

active

boolean | null

payment_conditions

string | null

reference

string | null

language

string

currency

string

discount

string | null

first_due_interval

integer

auto_send

boolean | null

sending_scheduled_at

string | null · date-time

sending_scheduled_user_id

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

A unique record identifier

frequency_type

string · enum

Enum values:

day

week

month

quarter

year

frequency

integer

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

object[]

POST/{administration_id}/recurring_sales_invoices/synchronization{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/recurring_sales_invoices/synchronization:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    471699742703748500,
    471699742745691500
  ]
}
'

shell

Example Request Body

{
  "ids": [
    471699742703748500,
    471699742745691500
  ]
}

json

application/json

Example Responses

[
  {
    "id": "471699742745691501",
    "administration_id": 123,
    "contact_id": "471699742669145447",
    "contact": {
      "id": "471699742669145447",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "2",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:52:31.359Z",
      "updated_at": "2025-11-25T10:52:31.359Z",
      "version": 1764067951,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6a65c6affbcb122152c60ef66dd6f6490c948841d81e3a24a93c290e4ed2ba9c/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "471699737092818060",
    "start_date": "2025-11-26",
    "invoice_date": "2025-11-26",
    "last_date": "2025-11-26",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "month",
    "frequency": 1,
    "created_at": "2025-11-25T10:52:31.432Z",
    "updated_at": "2025-11-25T10:52:31.437Z",
    "version": 1764067951,
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "471699742746740078",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "5 stuks",
        "amount_decimal": "5.0",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:31.434Z",
        "updated_at": "2025-11-25T10:52:31.434Z"
      },
      {
        "id": "471699742748837231",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "2 stuks",
        "amount_decimal": "2.0",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:31.436Z",
        "updated_at": "2025-11-25T10:52:31.436Z"
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:52:31.440Z",
        "updated_at": "2025-11-25T10:52:31.440Z"
      }
    ],
    "subscription": null
  },
  {
    "id": "471699742703748457",
    "administration_id": 123,
    "contact_id": "471699742669145447",
    "contact": {
      "id": "471699742669145447",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "2",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:52:31.359Z",
      "updated_at": "2025-11-25T10:52:31.359Z",
      "version": 1764067951,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6a65c6affbcb122152c60ef66dd6f6490c948841d81e3a24a93c290e4ed2ba9c/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "471699737092818060",
    "start_date": "2025-11-26",
    "invoice_date": "2025-11-26",
    "last_date": "2025-11-26",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "year",
    "frequency": 1,
    "created_at": "2025-11-25T10:52:31.393Z",
    "updated_at": "2025-11-25T10:52:31.399Z",
    "version": 1764067951,
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "471699742706894186",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "5 stuks",
        "amount_decimal": "5.0",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:31.395Z",
        "updated_at": "2025-11-25T10:52:31.395Z"
      },
      {
        "id": "471699742708991339",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "2 stuks",
        "amount_decimal": "2.0",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:31.397Z",
        "updated_at": "2025-11-25T10:52:31.397Z"
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:52:31.401Z",
        "updated_at": "2025-11-25T10:52:31.401Z"
      }
    ],
    "subscription": null
  }
]

json

application/json

Get a recurring sales invoice by id

GET

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{id}{format}

Get a recurring sales invoice by id.

Get a recurring sales invoice by id › 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

Get a recurring sales invoice by id › Responses

A recurring sales invoice

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

invoice_date

string · date

last_date

string | null · date

active

boolean | null

payment_conditions

string | null

reference

string | null

language

string

currency

string

discount

string | null

first_due_interval

integer

auto_send

boolean | null

sending_scheduled_at

string | null · date-time

sending_scheduled_user_id

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

A unique record identifier

frequency_type

string · enum

Enum values:

day

week

month

quarter

year

frequency

integer

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

object[]

GET/{administration_id}/recurring_sales_invoices/{id}{format}

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

shell

Example Responses

{
  "id": "471699743444043160",
  "administration_id": 123,
  "contact_id": "471699743401051541",
  "contact": {
    "id": "471699743401051541",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:52:32.057Z",
    "updated_at": "2025-11-25T10:52:32.057Z",
    "version": 1764067952,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d8349b09b8daea00aa1d00090d092f93a743b23444055a5cadbc9eb3f7e2784e/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "workflow_id": "471699737092818060",
  "start_date": "2025-11-26",
  "invoice_date": "2025-11-26",
  "last_date": "2025-11-26",
  "active": true,
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Project X",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "first_due_interval": 14,
  "auto_send": false,
  "sending_scheduled_at": null,
  "sending_scheduled_user_id": null,
  "frequency_type": "month",
  "frequency": 1,
  "created_at": "2025-11-25T10:52:32.098Z",
  "updated_at": "2025-11-25T10:52:32.106Z",
  "version": 1764067952,
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "2.91",
  "total_price_excl_tax_base": "2.91",
  "total_price_incl_tax": "3.52",
  "total_price_incl_tax_base": "3.52",
  "details": [
    {
      "id": "471699743447188889",
      "administration_id": 123,
      "tax_rate_id": "471699736823334023",
      "ledger_account_id": "471699736746787959",
      "project_id": null,
      "product_id": null,
      "amount": "5 stuks",
      "amount_decimal": "5.0",
      "description": "Appels",
      "price": "0.45",
      "period": null,
      "row_order": 1,
      "total_price_excl_tax_with_discount": "2.25",
      "total_price_excl_tax_with_discount_base": "2.25",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:52:32.101Z",
      "updated_at": "2025-11-25T10:52:32.101Z"
    },
    {
      "id": "471699743450334618",
      "administration_id": 123,
      "tax_rate_id": "471699736823334023",
      "ledger_account_id": "471699736746787959",
      "project_id": null,
      "product_id": null,
      "amount": "2 stuks",
      "amount_decimal": "2.0",
      "description": "Peren",
      "price": "0.33",
      "period": null,
      "row_order": 2,
      "total_price_excl_tax_with_discount": "0.66",
      "total_price_excl_tax_with_discount_base": "0.66",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:52:32.104Z",
      "updated_at": "2025-11-25T10:52:32.104Z"
    }
  ],
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "recurring_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:52:32.108Z",
      "updated_at": "2025-11-25T10:52:32.108Z"
    }
  ],
  "subscription": null
}

json

application/json

Destroy or deactivate a recurring sales invoice

DELETE

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{id}{format}

A recurring sales invoice will be destroyed if it has not created any sales invoices. If it has created sales invoices, it will be deactivated.

Destroy or deactivate a recurring sales invoice › 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

Destroy or deactivate a recurring sales invoice › Responses

Recurring sales invoice deleted

No data returned

DELETE/{administration_id}/recurring_sales_invoices/{id}{format}

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

shell

Example Responses

No example specified for this content type

Updates a recurring sales invoice

PATCH

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{id}{format}

Updates a recurring sales invoice. Only possible if the recurring sales invoice has no active subscription.

Updates a recurring sales invoice › 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 recurring sales invoice › Request Body

object

Updates a recurring sales invoice › Responses

Recurring sales invoice updated

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

invoice_date

string · date

last_date

string | null · date

active

boolean | null

payment_conditions

string | null

reference

string | null

language

string

currency

string

discount

string | null

first_due_interval

integer

auto_send

boolean | null

sending_scheduled_at

string | null · date-time

sending_scheduled_user_id

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

A unique record identifier

frequency_type

string · enum

Enum values:

day

week

month

quarter

year

frequency

integer

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

object[]

PATCH/{administration_id}/recurring_sales_invoices/{id}{format}

curl --request PATCH \
  --url https://moneybird.com/api/v2/:administration_id/recurring_sales_invoices/:id:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "recurring_sales_invoice": {
    "details_attributes": {
      "0": {
        "id": 471699748327262000,
        "price": 10
      }
    }
  }
}
'

shell

Example Request Body

{
  "recurring_sales_invoice": {
    "details_attributes": {
      "0": {
        "id": 471699748327262000,
        "price": 10
      }
    }
  }
}

json

application/json

Example Responses

{
  "id": "471699748326213462",
  "administration_id": 123,
  "contact_id": "471699748287416147",
  "contact": {
    "id": "471699748287416147",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:52:36.717Z",
    "updated_at": "2025-11-25T10:52:36.717Z",
    "version": 1764067956,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/21536c697356fdb1f3ab07e03a0614c7eed0335ad7d7009b9b009214bdcf4311/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "workflow_id": "471699737092818060",
  "start_date": "2025-11-26",
  "invoice_date": "2025-11-26",
  "last_date": "2025-11-26",
  "active": true,
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Project X",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "first_due_interval": 14,
  "auto_send": false,
  "sending_scheduled_at": null,
  "sending_scheduled_user_id": null,
  "frequency_type": "month",
  "frequency": 1,
  "created_at": "2025-11-25T10:52:36.754Z",
  "updated_at": "2025-11-25T10:52:36.785Z",
  "version": 1764067956,
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "50.66",
  "total_price_excl_tax_base": "50.66",
  "total_price_incl_tax": "61.3",
  "total_price_incl_tax_base": "61.3",
  "details": [
    {
      "id": "471699748327262039",
      "administration_id": 123,
      "tax_rate_id": "471699736823334023",
      "ledger_account_id": "471699736746787959",
      "project_id": null,
      "product_id": null,
      "amount": "5 stuks",
      "amount_decimal": "5.0",
      "description": "Appels",
      "price": "10.0",
      "period": null,
      "row_order": 1,
      "total_price_excl_tax_with_discount": "50.0",
      "total_price_excl_tax_with_discount_base": "50.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:52:36.755Z",
      "updated_at": "2025-11-25T10:52:36.782Z"
    },
    {
      "id": "471699748329359192",
      "administration_id": 123,
      "tax_rate_id": "471699736823334023",
      "ledger_account_id": "471699736746787959",
      "project_id": null,
      "product_id": null,
      "amount": "2 stuks",
      "amount_decimal": "2.0",
      "description": "Peren",
      "price": "0.33",
      "period": null,
      "row_order": 2,
      "total_price_excl_tax_with_discount": "0.66",
      "total_price_excl_tax_with_discount_base": "0.66",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:52:36.757Z",
      "updated_at": "2025-11-25T10:52:36.757Z"
    }
  ],
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "recurring_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:52:36.760Z",
      "updated_at": "2025-11-25T10:52:36.760Z"
    }
  ],
  "subscription": null
}

json

application/json

Destroys note from entity

DELETE

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes/{id}{format}

Deletes a note from the recurring sales invoice.

Destroys note from entity › path Parameters

administration_id

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

The unique identifier of the administration

A unique record identifier

recurring_sales_invoice_id

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

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

Destroys note from entity › Responses

Note deleted

No data returned

DELETE/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes/{id}{format}

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

shell

Example Responses

No example specified for this content type

Adds note to entity

POST

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes{format}

Adds a note to the recurring sales invoice.

Adds note to entity › path Parameters

administration_id

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

The unique identifier of the administration

A unique record identifier

recurring_sales_invoice_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

Adds note to entity › Request Body

object

Adds note to entity › Responses

Note created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

entity_id

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

A unique record identifier

entity_type

string

user_id

string | integer · pattern: ^\d+$

A unique record identifier

assignee_id

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

A unique record identifier

todo

boolean | string | null

Default: false

note

string | null

completed_at

string | null · date-time

completed_by_id

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

A unique record identifier

todo_type

string | null · enum

Enum values:

sales_invoice_due

purchase_invoice_due

general_document_reminder

general_document_due

new_document_awaiting_processing

new_financial_mutation_awaiting_processing

financial_mutations_not_updated

sales_invoice_payment_not_linked_to_financial_mutation

data

object | null

created_at

string · date-time

updated_at

string · date-time

POST/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/recurring_sales_invoices/:recurring_sales_invoice_id/notes:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": {
    "note": "Text of the note",
    "assignee_id": 471699747241985800,
    "todo": true
  }
}
'

shell

Example Request Body

{
  "note": {
    "note": "Text of the note",
    "assignee_id": 471699747241985800,
    "todo": true
  }
}

json

application/json

Example Responses

{
  "id": "471699747267151609",
  "administration_id": 123,
  "entity_id": "471699747226257139",
  "entity_type": "RecurringSalesInvoice",
  "user_id": 17640679459010,
  "assignee_id": "471699747241985783",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {},
  "created_at": "2025-11-25T10:52:35.744Z",
  "updated_at": "2025-11-25T10:52:35.744Z"
}

json

application/json

List all recurring sales invoices

GET

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices{format}

Returns a paginated list of all recurring sales invoices in the administration.

The filter argument allows you to filter on the list of recurring invoices. Filters are a combination of keys and values, separated by a comma: state:active,contact_id:123. The available options for filtering are:

Filter	Type	Default	Description
state	`String`	`active`	`active` or `inactive`
frequency	`String`	`all`	`all`, `day`, `week`, `month`, `quarter` or `year`
auto_send	`Boolean`	`null`	`null`, `true` or `false`
contact_id	`Integer`		Filters recurring invoices by a single contact
workflow_id	`Integer`		Filters recurring invoices by a single workflow

List all recurring sales invoices › 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 recurring sales invoices › query Parameters

filter

string

page

integer | string

per_page

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

List all recurring sales invoices › Responses

A list of recurring sales invoices

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

invoice_date

string · date

last_date

string | null · date

active

boolean | null

payment_conditions

string | null

reference

string | null

language

string

currency

string

discount

string | null

first_due_interval

integer

auto_send

boolean | null

sending_scheduled_at

string | null · date-time

sending_scheduled_user_id

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

A unique record identifier

frequency_type

string · enum

Enum values:

day

week

month

quarter

year

frequency

integer

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

object[]

GET/{administration_id}/recurring_sales_invoices{format}

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

shell

Example Responses

[
  {
    "id": "471699744314361313",
    "administration_id": 123,
    "contact_id": "471699744221038039",
    "contact": {
      "id": "471699744221038039",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "2",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:52:32.839Z",
      "updated_at": "2025-11-25T10:52:32.839Z",
      "version": 1764067952,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ee6e333f7f8e940444e365e2372be7b35cc70234a27812c068ece17cc069eff8/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "471699737092818060",
    "start_date": "2025-11-26",
    "invoice_date": "2025-11-26",
    "last_date": "2025-11-26",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "year",
    "frequency": 1,
    "created_at": "2025-11-25T10:52:32.929Z",
    "updated_at": "2025-11-25T10:52:32.934Z",
    "version": 1764067952,
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "471699744316458466",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "5 stuks",
        "amount_decimal": "5.0",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.931Z",
        "updated_at": "2025-11-25T10:52:32.931Z"
      },
      {
        "id": "471699744318555619",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "2 stuks",
        "amount_decimal": "2.0",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.932Z",
        "updated_at": "2025-11-25T10:52:32.932Z"
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:52:32.935Z",
        "updated_at": "2025-11-25T10:52:32.935Z"
      }
    ],
    "subscription": null
  },
  {
    "id": "471699744280806877",
    "administration_id": 123,
    "contact_id": "471699744221038039",
    "contact": {
      "id": "471699744221038039",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "2",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:52:32.839Z",
      "updated_at": "2025-11-25T10:52:32.839Z",
      "version": 1764067952,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ee6e333f7f8e940444e365e2372be7b35cc70234a27812c068ece17cc069eff8/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "471699737092818060",
    "start_date": "2025-11-26",
    "invoice_date": "2025-11-26",
    "last_date": "2025-11-26",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "year",
    "frequency": 1,
    "created_at": "2025-11-25T10:52:32.897Z",
    "updated_at": "2025-11-25T10:52:32.902Z",
    "version": 1764067952,
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "471699744282904030",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "5 stuks",
        "amount_decimal": "5.0",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.898Z",
        "updated_at": "2025-11-25T10:52:32.898Z"
      },
      {
        "id": "471699744285001183",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "2 stuks",
        "amount_decimal": "2.0",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.900Z",
        "updated_at": "2025-11-25T10:52:32.900Z"
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:52:32.903Z",
        "updated_at": "2025-11-25T10:52:32.903Z"
      }
    ],
    "subscription": null
  },
  {
    "id": "471699744249349593",
    "administration_id": 123,
    "contact_id": "471699744221038039",
    "contact": {
      "id": "471699744221038039",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "2",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:52:32.839Z",
      "updated_at": "2025-11-25T10:52:32.839Z",
      "version": 1764067952,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ee6e333f7f8e940444e365e2372be7b35cc70234a27812c068ece17cc069eff8/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "471699737092818060",
    "start_date": "2025-11-26",
    "invoice_date": "2025-11-26",
    "last_date": "2025-11-26",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "year",
    "frequency": 1,
    "created_at": "2025-11-25T10:52:32.866Z",
    "updated_at": "2025-11-25T10:52:32.871Z",
    "version": 1764067952,
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "471699744250398170",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "5 stuks",
        "amount_decimal": "5.0",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.868Z",
        "updated_at": "2025-11-25T10:52:32.868Z"
      },
      {
        "id": "471699744252495323",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "2 stuks",
        "amount_decimal": "2.0",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.869Z",
        "updated_at": "2025-11-25T10:52:32.869Z"
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:52:32.873Z",
        "updated_at": "2025-11-25T10:52:32.873Z"
      }
    ],
    "subscription": null
  },
  {
    "id": "471699744204260818",
    "administration_id": 123,
    "contact_id": "471699744166512079",
    "contact": {
      "id": "471699744166512079",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:52:32.787Z",
      "updated_at": "2025-11-25T10:52:32.787Z",
      "version": 1764067952,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6f5fe7e2dd9c212cacecb5d1af4fa541791b1b1d242036e9fe09e61c2c10cb50/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "471699737092818060",
    "start_date": "2025-11-26",
    "invoice_date": "2025-11-26",
    "last_date": "2025-11-26",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "month",
    "frequency": 1,
    "created_at": "2025-11-25T10:52:32.824Z",
    "updated_at": "2025-11-25T10:52:32.829Z",
    "version": 1764067952,
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "471699744206357971",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "5 stuks",
        "amount_decimal": "5.0",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.825Z",
        "updated_at": "2025-11-25T10:52:32.825Z"
      },
      {
        "id": "471699744208455124",
        "administration_id": 123,
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "project_id": null,
        "product_id": null,
        "amount": "2 stuks",
        "amount_decimal": "2.0",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:52:32.827Z",
        "updated_at": "2025-11-25T10:52:32.827Z"
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:52:32.830Z",
        "updated_at": "2025-11-25T10:52:32.830Z"
      }
    ],
    "subscription": null
  }
]

json

application/json

Creates a new recurring sales invoice

POST

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices{format}

A recurring sales invoice will create new sales invoices on set intervals. To create a new recurring sales invoice, you need to provide at least a contact and details for the invoice. Furthermore you need to determine the planning. The following fields will influence the planning:

invoice_date: the date in which the first invoice should be created
frequency_type: the type of frequency you want to use, for example month
frequency: defines the actual frequency, e.g. frequency=2 and frequency_type=month will create an invoice every 2 months
has_desired_count: whether or not the desired count should take effect
desired_count: maximum number of sales invoices to create

Creates a new recurring sales invoice › 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 recurring sales invoice › Request Body

object

Creates a new recurring sales invoice › Responses

Recurring sales invoice created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

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

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

invoice_date

string · date

last_date

string | null · date

active

boolean | null

payment_conditions

string | null

reference

string | null

language

string

currency

string

discount

string | null

first_due_interval

integer

auto_send

boolean | null

sending_scheduled_at

string | null · date-time

sending_scheduled_user_id

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

A unique record identifier

frequency_type

string · enum

Enum values:

day

week

month

quarter

year

frequency

integer

created_at

string | null · date-time

updated_at

string | null · date-time

version

integer

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

object[]

POST/{administration_id}/recurring_sales_invoices{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/recurring_sales_invoices:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "recurring_sales_invoice": {
    "reference": "My recurring invoice",
    "contact_id": 471699746811021000,
    "invoice_date": "2030-01-01",
    "details_attributes": {
      "0": {
        "description": "Table",
        "price": "10.5",
        "tax_rate_id": 471699746823603900,
        "ledger_account_id": 471699746833041100
      }
    }
  }
}
'

shell

Example Request Body

{
  "recurring_sales_invoice": {
    "reference": "My recurring invoice",
    "contact_id": 471699746811021000,
    "invoice_date": "2030-01-01",
    "details_attributes": {
      "0": {
        "description": "Table",
        "price": "10.5",
        "tax_rate_id": 471699746823603900,
        "ledger_account_id": 471699746833041100
      }
    }
  }
}

json

application/json

Example Responses

{
  "id": "471699746866595535",
  "administration_id": 123,
  "contact_id": "471699746811021000",
  "contact": {
    "id": "471699746811021000",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "2",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:52:35.309Z",
    "updated_at": "2025-11-25T10:52:35.309Z",
    "version": 1764067955,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/2654f7f1c75053772eef588a85c817fbd0dfa54ac53b7aa6e90ac85b7e139061/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "workflow_id": "471699737092818060",
  "start_date": "2030-01-01",
  "invoice_date": "2030-01-01",
  "last_date": null,
  "active": true,
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "My recurring invoice",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "first_due_interval": 14,
  "auto_send": false,
  "sending_scheduled_at": null,
  "sending_scheduled_user_id": null,
  "frequency_type": "year",
  "frequency": 1,
  "created_at": "2025-11-25T10:52:35.363Z",
  "updated_at": "2025-11-25T10:52:35.366Z",
  "version": 1764067955,
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "10.5",
  "total_price_excl_tax_base": "10.5",
  "total_price_incl_tax": "12.71",
  "total_price_incl_tax_base": "12.71",
  "details": [
    {
      "id": "471699746868692688",
      "administration_id": 123,
      "tax_rate_id": "471699746823603915",
      "ledger_account_id": "471699746833041101",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "Table",
      "price": "10.5",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "10.5",
      "total_price_excl_tax_with_discount_base": "10.5",
      "tax_report_reference": [],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:52:35.364Z",
      "updated_at": "2025-11-25T10:52:35.364Z"
    }
  ],
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "recurring_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:52:35.367Z",
      "updated_at": "2025-11-25T10:52:35.367Z"
    }
  ],
  "subscription": null
}

json

application/json

Purchase transactions Reports