Recurring sales invoices

cURL Ruby

List all recurring sales invoices

GET /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

Parameters

Parameter Type Description
filter String
per_page Integer

Example: returns all recurring sales invoices of an administration

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "446241770739599045",
    "administration_id": 123,
    "contact_id": "446241770589652667",
    "contact": {
      "id": "446241770589652667",
      "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-02-17T10:48:57.239Z",
      "updated_at": "2025-02-17T10:48:57.239Z",
      "version": 1739789337,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d092650521374781920d72a50845bccea20ed865e954beaf4a373812e4c0f4ab/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "446241519125398683",
    "start_date": "2025-02-18",
    "invoice_date": "2025-02-18",
    "last_date": "2025-02-18",
    "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-02-17T10:48:57.383Z",
    "updated_at": "2025-02-17T10:48:57.395Z",
    "version": 1739789337,
    "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": "446241770743793350",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.385Z",
        "updated_at": "2025-02-17T10:48:57.385Z",
        "time_entries": []
      },
      {
        "id": "446241770751133383",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.393Z",
        "updated_at": "2025-02-17T10:48:57.393Z",
        "time_entries": []
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17397890963220,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-02-17T10:48:57.397Z",
        "updated_at": "2025-02-17T10:48:57.397Z"
      }
    ],
    "subscription": null
  },
  {
    "id": "446241770680878785",
    "administration_id": 123,
    "contact_id": "446241770589652667",
    "contact": {
      "id": "446241770589652667",
      "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-02-17T10:48:57.239Z",
      "updated_at": "2025-02-17T10:48:57.239Z",
      "version": 1739789337,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d092650521374781920d72a50845bccea20ed865e954beaf4a373812e4c0f4ab/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "446241519125398683",
    "start_date": "2025-02-18",
    "invoice_date": "2025-02-18",
    "last_date": "2025-02-18",
    "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-02-17T10:48:57.326Z",
    "updated_at": "2025-02-17T10:48:57.343Z",
    "version": 1739789337,
    "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": "446241770682975938",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.329Z",
        "updated_at": "2025-02-17T10:48:57.329Z",
        "time_entries": []
      },
      {
        "id": "446241770695558851",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.331Z",
        "updated_at": "2025-02-17T10:48:57.331Z",
        "time_entries": []
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17397890963220,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-02-17T10:48:57.346Z",
        "updated_at": "2025-02-17T10:48:57.346Z"
      }
    ],
    "subscription": null
  },
  {
    "id": "446241770625304253",
    "administration_id": 123,
    "contact_id": "446241770589652667",
    "contact": {
      "id": "446241770589652667",
      "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-02-17T10:48:57.239Z",
      "updated_at": "2025-02-17T10:48:57.239Z",
      "version": 1739789337,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d092650521374781920d72a50845bccea20ed865e954beaf4a373812e4c0f4ab/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "446241519125398683",
    "start_date": "2025-02-18",
    "invoice_date": "2025-02-18",
    "last_date": "2025-02-18",
    "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-02-17T10:48:57.273Z",
    "updated_at": "2025-02-17T10:48:57.280Z",
    "version": 1739789337,
    "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": "446241770627401406",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.275Z",
        "updated_at": "2025-02-17T10:48:57.275Z",
        "time_entries": []
      },
      {
        "id": "446241770629498559",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.278Z",
        "updated_at": "2025-02-17T10:48:57.278Z",
        "time_entries": []
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17397890963220,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-02-17T10:48:57.281Z",
        "updated_at": "2025-02-17T10:48:57.281Z"
      }
    ],
    "subscription": null
  }
]

Example: returns recurring invoices filtered on frequency

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices.json?filter=frequency%3Amonth

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "446241770936731342",
    "administration_id": 123,
    "contact_id": "446241770894788299",
    "contact": {
      "id": "446241770894788299",
      "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-02-17T10:48:57.531Z",
      "updated_at": "2025-02-17T10:48:57.531Z",
      "version": 1739789337,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/12890cdc3074c22471af7670afde4bc3c9a1eb7ada63a931e0477b3efc45c1e3/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "446241519125398683",
    "start_date": "2025-02-18",
    "invoice_date": "2025-02-18",
    "last_date": "2025-02-18",
    "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-02-17T10:48:57.571Z",
    "updated_at": "2025-02-17T10:48:57.576Z",
    "version": 1739789337,
    "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": "446241770938828495",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.573Z",
        "updated_at": "2025-02-17T10:48:57.573Z",
        "time_entries": []
      },
      {
        "id": "446241770940925648",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.574Z",
        "updated_at": "2025-02-17T10:48:57.574Z",
        "time_entries": []
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17397890963220,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-02-17T10:48:57.577Z",
        "updated_at": "2025-02-17T10:48:57.577Z"
      }
    ],
    "subscription": null
  }
]

Example: returns recurring invoices filtered on contact

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices.json?filter=contact_id%3A446241771302684391

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "446241771344627434",
    "administration_id": 123,
    "contact_id": "446241771302684391",
    "contact": {
      "id": "446241771302684391",
      "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-02-17T10:48:57.919Z",
      "updated_at": "2025-02-17T10:48:57.919Z",
      "version": 1739789337,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/a71baa8ddc4a59eef66eadb2815760c8e6de45d2af17d1f232057be353fe8180/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "446241519125398683",
    "start_date": "2025-02-18",
    "invoice_date": "2025-02-18",
    "last_date": "2025-02-18",
    "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-02-17T10:48:57.959Z",
    "updated_at": "2025-02-17T10:48:57.966Z",
    "version": 1739789337,
    "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": "446241771346724587",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.961Z",
        "updated_at": "2025-02-17T10:48:57.961Z",
        "time_entries": []
      },
      {
        "id": "446241771348821740",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:57.964Z",
        "updated_at": "2025-02-17T10:48:57.964Z",
        "time_entries": []
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17397890963220,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-02-17T10:48:57.968Z",
        "updated_at": "2025-02-17T10:48:57.968Z"
      }
    ],
    "subscription": null
  }
]

Example: returns paginated recurring sales invoices on page 1

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices.json?per_page=1

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "446241771974821656",
    "administration_id": 123,
    "contact_id": "446241771820680974",
    "contact": {
      "id": "446241771820680974",
      "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-02-17T10:48:58.413Z",
      "updated_at": "2025-02-17T10:48:58.413Z",
      "version": 1739789338,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8d3457557db18ac9312c848c12fad38e5ce0a848e8ccc9552d062fe35517e8fb/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "446241519125398683",
    "start_date": "2025-02-18",
    "invoice_date": "2025-02-18",
    "last_date": "2025-02-18",
    "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-02-17T10:48:58.560Z",
    "updated_at": "2025-02-17T10:48:58.566Z",
    "version": 1739789338,
    "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": "446241771976918809",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:58.562Z",
        "updated_at": "2025-02-17T10:48:58.562Z",
        "time_entries": []
      },
      {
        "id": "446241771979015962",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:58.564Z",
        "updated_at": "2025-02-17T10:48:58.564Z",
        "time_entries": []
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17397890963220,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-02-17T10:48:58.567Z",
        "updated_at": "2025-02-17T10:48:58.567Z"
      }
    ],
    "subscription": null
  }
]

Example: returns paginated recurring sales invoices on page 2

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices.json?page=2&per_page=1

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "446241772254791468",
    "administration_id": 123,
    "contact_id": "446241772175099686",
    "contact": {
      "id": "446241772175099686",
      "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-02-17T10:48:58.751Z",
      "updated_at": "2025-02-17T10:48:58.751Z",
      "version": 1739789338,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/62ef39eba158a97eaace50aa260fdaccb79086eb97a548b885e0cbee1a50d17c/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "workflow_id": "446241519125398683",
    "start_date": "2025-02-18",
    "invoice_date": "2025-02-18",
    "last_date": "2025-02-18",
    "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-02-17T10:48:58.827Z",
    "updated_at": "2025-02-17T10:48:58.832Z",
    "version": 1739789338,
    "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": "446241772255840045",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:58.829Z",
        "updated_at": "2025-02-17T10:48:58.829Z",
        "time_entries": []
      },
      {
        "id": "446241772257937198",
        "administration_id": 123,
        "tax_rate_id": "446241518957626516",
        "ledger_account_id": "446241518911489156",
        "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-02-17T10:48:58.831Z",
        "updated_at": "2025-02-17T10:48:58.831Z",
        "time_entries": []
      }
    ],
    "custom_fields": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17397890963220,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-02-17T10:48:58.833Z",
        "updated_at": "2025-02-17T10:48:58.833Z"
      }
    ],
    "subscription": null
  }
]

Example: returns an error when too many recurring sales invoices are requested

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices.json?per_page=101

Response

        
          
          Status: 400 Bad Request
        
      
{
  "error": "per_page does not have a valid value"
}

List all IDs and versions

GET /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.

Parameters

Parameter Type Description
filter String

Example: retrieves the IDs for synchronization

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/synchronization.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "446241775321876452",
    "version": 1739789341
  },
  {
    "id": "446241775264204765",
    "version": 1739789341
  }
]

Example: retrieves the IDs for synchronization with a filter

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/synchronization.json?filter=frequency%3Amonth

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "446241775489648621",
    "version": 1739789341
  }
]

Fetch recurring sales invoices with given IDs

POST /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.

Parameters

Parameter Type Description
ids Array[integer]

Required

Get a recurring sales invoice by id

GET /recurring_sales_invoices/:id(.:format)

Example: returns invoice by given id

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/446241772836751185.json?

Response

        
          
          Status: 200 OK
        
      
{
  "id": "446241772836751185",
  "administration_id": 123,
  "contact_id": "446241772752865102",
  "contact": {
    "id": "446241772752865102",
    "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-02-17T10:48:59.301Z",
    "updated_at": "2025-02-17T10:48:59.301Z",
    "version": 1739789339,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/9670c79802bfc6771c5876432cc25aaf790e7c79b4718a9685f7d3112435309d/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "workflow_id": "446241519125398683",
  "start_date": "2025-02-18",
  "invoice_date": "2025-02-18",
  "last_date": "2025-02-18",
  "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-02-17T10:48:59.383Z",
  "updated_at": "2025-02-17T10:48:59.389Z",
  "version": 1739789339,
  "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": "446241772838848338",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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-02-17T10:48:59.385Z",
      "updated_at": "2025-02-17T10:48:59.385Z",
      "time_entries": []
    },
    {
      "id": "446241772841994067",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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-02-17T10:48:59.387Z",
      "updated_at": "2025-02-17T10:48:59.387Z",
      "time_entries": []
    }
  ],
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17397890963220,
      "action": "recurring_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:48:59.392Z",
      "updated_at": "2025-02-17T10:48:59.392Z"
    }
  ],
  "subscription": null
}

Example: returns 404 when invoice does not exist

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/34123123.json?

Response

        
          
          Status: 404 Not Found
        
      
{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}

Creates a new recurring sales invoice

POST /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:

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

Parameters

Parameter Type Description
recurring_sales_invoice[document_style_id] Integer

Should be a valid document style id.
recurring_sales_invoice[contact_id] Integer

Should be a valid contact id.
recurring_sales_invoice[contact_person_id] Integer

Should be a valid contact person id.
recurring_sales_invoice[update_contact] Boolean
recurring_sales_invoice[reference] String
recurring_sales_invoice[invoice_date] String

Should be in the future.
recurring_sales_invoice[workflow_id] Integer

Should be a valid workflow id.
recurring_sales_invoice[currency] String

ISO three-character currency code, e.g. EUR or USD.
recurring_sales_invoice[first_due_interval] Integer
recurring_sales_invoice[prices_are_incl_tax] Boolean
recurring_sales_invoice[discount] Decimal

Discount percentage, e.g. 10,0%.
recurring_sales_invoice[frequency_type] String

Can be day, week, month, quarter or year.
recurring_sales_invoice[frequency] String
recurring_sales_invoice[has_desired_count] Boolean
recurring_sales_invoice[desired_count] String
recurring_sales_invoice[auto_send] Boolean
recurring_sales_invoice[mergeable] Boolean
recurring_sales_invoice[details_attributes][id] Integer
recurring_sales_invoice[details_attributes][description] String
recurring_sales_invoice[details_attributes][period] String

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.
recurring_sales_invoice[details_attributes][price] Decimal

Both a decimal and a string ‘10,95’ are accepted.
recurring_sales_invoice[details_attributes][amount] String
recurring_sales_invoice[details_attributes][tax_rate_id] Integer

Should be a valid tax rate id.
recurring_sales_invoice[details_attributes][ledger_account_id] Integer

Should be a valid ledger account id.
recurring_sales_invoice[details_attributes][product_id] Integer

Should be a valid product id.
recurring_sales_invoice[details_attributes][project_id] Integer

Should be a valid project id.
recurring_sales_invoice[details_attributes][row_order] Integer
recurring_sales_invoice[details_attributes][_destroy] Boolean
recurring_sales_invoice[details_attributes][automated_tax_enabled] Boolean
recurring_sales_invoice[custom_fields_attributes][id] Integer

Required
recurring_sales_invoice[custom_fields_attributes][value] String

Required

Example: creates a new recurring sales invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"recurring_sales_invoice":{"reference":"My recurring invoice","contact_id":446241773590677369,"invoice_date":"2030-01-01","details_attributes":{"0":{"description":"Table","price":"10.5","tax_rate_id":446241773608503164,"ledger_account_id":446241773618988926}}}}' \
  https://moneybird.com/api/v2/123/recurring_sales_invoices.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "446241773695534976",
  "administration_id": 123,
  "contact_id": "446241773590677369",
  "contact": {
    "id": "446241773590677369",
    "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-02-17T10:49:00.100Z",
    "updated_at": "2025-02-17T10:49:00.100Z",
    "version": 1739789340,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/7bcc70ffc5a588938da9a7b63b767ab1af3a6fc982eba8aaac488bff5850d6a0/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "workflow_id": "446241519125398683",
  "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-02-17T10:49:00.201Z",
  "updated_at": "2025-02-17T10:49:00.206Z",
  "version": 1739789340,
  "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": "446241773697632129",
      "administration_id": 123,
      "tax_rate_id": "446241773608503164",
      "ledger_account_id": "446241773618988926",
      "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-02-17T10:49:00.203Z",
      "updated_at": "2025-02-17T10:49:00.203Z",
      "time_entries": []
    }
  ],
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17397890963220,
      "action": "recurring_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:49:00.208Z",
      "updated_at": "2025-02-17T10:49:00.208Z"
    }
  ],
  "subscription": null
}

Updates a recurring sales invoice

PATCH /recurring_sales_invoices/:id(.:format)

Example: updates the recurring sales invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"recurring_sales_invoice":{"reference":"Reference changed"}}' \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/446241774096091036.json

Response

        
          
          Status: 200 OK
        
      
{
  "id": "446241774096091036",
  "administration_id": 123,
  "contact_id": "446241774043662233",
  "contact": {
    "id": "446241774043662233",
    "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-02-17T10:49:00.533Z",
    "updated_at": "2025-02-17T10:49:00.533Z",
    "version": 1739789340,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/a3e75be70d8c5a7f978714bf80cc78190a2b0558b4831974e7f7cfb08d71e3a6/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "workflow_id": "446241519125398683",
  "start_date": "2025-02-18",
  "invoice_date": "2025-02-18",
  "last_date": "2025-02-18",
  "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": "Reference changed",
  "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-02-17T10:49:00.584Z",
  "updated_at": "2025-02-17T10:49:00.652Z",
  "version": 1739789340,
  "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": "446241774098188189",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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-02-17T10:49:00.585Z",
      "updated_at": "2025-02-17T10:49:00.585Z",
      "time_entries": []
    },
    {
      "id": "446241774099236766",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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-02-17T10:49:00.587Z",
      "updated_at": "2025-02-17T10:49:00.587Z",
      "time_entries": []
    }
  ],
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17397890963220,
      "action": "recurring_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:49:00.590Z",
      "updated_at": "2025-02-17T10:49:00.590Z"
    }
  ],
  "subscription": null
}

Example: updates a recurring sales invoice detail

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"recurring_sales_invoice":{"details_attributes":{"0":{"id":446241774311049126,"price":10.0}}}}' \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/446241774308951973.json

Response

        
          
          Status: 200 OK
        
      
{
  "id": "446241774308951973",
  "administration_id": 123,
  "contact_id": "446241774274348962",
  "contact": {
    "id": "446241774274348962",
    "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-02-17T10:49:00.754Z",
    "updated_at": "2025-02-17T10:49:00.754Z",
    "version": 1739789340,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6e7d0a963f14ae80edb76e217f921cebe4708c12099d31d651828f1b1f8877d6/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "workflow_id": "446241519125398683",
  "start_date": "2025-02-18",
  "invoice_date": "2025-02-18",
  "last_date": "2025-02-18",
  "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-02-17T10:49:00.786Z",
  "updated_at": "2025-02-17T10:49:00.859Z",
  "version": 1739789340,
  "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": "446241774311049126",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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-02-17T10:49:00.789Z",
      "updated_at": "2025-02-17T10:49:00.856Z",
      "time_entries": []
    },
    {
      "id": "446241774313146279",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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-02-17T10:49:00.791Z",
      "updated_at": "2025-02-17T10:49:00.791Z",
      "time_entries": []
    }
  ],
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17397890963220,
      "action": "recurring_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:49:00.793Z",
      "updated_at": "2025-02-17T10:49:00.793Z"
    }
  ],
  "subscription": null
}

Destroy or deactivate a recurring sales invoice

DELETE /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.

Example: destroys a recurring sales invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/446241775086995411.json

Response

        
          
          Status: 204 No Content

Adds note to entity

POST /recurring_sales_invoices/:recurring_sales_invoice_id/notes(.:format)

Parameters

Parameter Type Description
note[note] String

Required. Text for the note or to-do.
note[todo] Boolean

If true the note is a to-do.
note[assignee_id] Integer

Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do.

Example: create a note

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"note":{"note":"Text of the note","assignee_id":446241776035955733,"todo":true}}' \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/446241776023372817/notes.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "446241776095724567",
  "administration_id": 123,
  "entity_id": "446241776023372817",
  "entity_type": "RecurringSalesInvoice",
  "user_id": 17397890963220,
  "assignee_id": "446241776035955733",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {},
  "created_at": "2025-02-17T10:49:02.489Z",
  "updated_at": "2025-02-17T10:49:02.489Z"
}

Destroys note from entity

DELETE /recurring_sales_invoices/:recurring_sales_invoice_id/notes/:id(.:format)

Example: destroy a note

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/446241776199533598/notes/446241776215262242.json

Response

        
          
          Status: 204 No Content