Recurring sales invoices
List all recurring sales invoices
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 |
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": "433546321648944984",
"administration_id": 123,
"contact_id": "433546321461249870",
"contact": {
"id": "433546321461249870",
"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": "2024-09-30T07:40:13.439Z",
"updated_at": "2024-09-30T07:40:13.439Z",
"version": 1727682013,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6a32ddcb373d6875f6f58cce245099ef6bf27bb9800bec8ebcf9e5b4e142f4ad/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:13.619Z",
"updated_at": "2024-09-30T07:40:13.624Z",
"version": 1727682013,
"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": "433546321649993561",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.621Z",
"updated_at": "2024-09-30T07:40:13.621Z"
},
{
"id": "433546321652090714",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.623Z",
"updated_at": "2024-09-30T07:40:13.623Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:13.626Z",
"updated_at": "2024-09-30T07:40:13.626Z"
}
],
"subscription": null
},
{
"id": "433546321592321876",
"administration_id": 123,
"contact_id": "433546321461249870",
"contact": {
"id": "433546321461249870",
"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": "2024-09-30T07:40:13.439Z",
"updated_at": "2024-09-30T07:40:13.439Z",
"version": 1727682013,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6a32ddcb373d6875f6f58cce245099ef6bf27bb9800bec8ebcf9e5b4e142f4ad/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:13.564Z",
"updated_at": "2024-09-30T07:40:13.573Z",
"version": 1727682013,
"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": "433546321594419029",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.567Z",
"updated_at": "2024-09-30T07:40:13.567Z"
},
{
"id": "433546321597564758",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.570Z",
"updated_at": "2024-09-30T07:40:13.570Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:13.575Z",
"updated_at": "2024-09-30T07:40:13.575Z"
}
],
"subscription": null
},
{
"id": "433546321512630096",
"administration_id": 123,
"contact_id": "433546321461249870",
"contact": {
"id": "433546321461249870",
"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": "2024-09-30T07:40:13.439Z",
"updated_at": "2024-09-30T07:40:13.439Z",
"version": 1727682013,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6a32ddcb373d6875f6f58cce245099ef6bf27bb9800bec8ebcf9e5b4e142f4ad/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:13.489Z",
"updated_at": "2024-09-30T07:40:13.495Z",
"version": 1727682013,
"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": "433546321514727249",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.491Z",
"updated_at": "2024-09-30T07:40:13.491Z"
},
{
"id": "433546321516824402",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.493Z",
"updated_at": "2024-09-30T07:40:13.493Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:13.497Z",
"updated_at": "2024-09-30T07:40:13.497Z"
}
],
"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": "433546321912137569",
"administration_id": 123,
"contact_id": "433546321825105758",
"contact": {
"id": "433546321825105758",
"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": "2024-09-30T07:40:13.787Z",
"updated_at": "2024-09-30T07:40:13.787Z",
"version": 1727682013,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c57236202b3a37010395009468388b015537fb28d5c65b3653e81a772655ddb2/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:13.870Z",
"updated_at": "2024-09-30T07:40:13.878Z",
"version": 1727682013,
"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": "433546321916331874",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.873Z",
"updated_at": "2024-09-30T07:40:13.873Z"
},
{
"id": "433546321918429027",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:13.877Z",
"updated_at": "2024-09-30T07:40:13.877Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:13.882Z",
"updated_at": "2024-09-30T07:40:13.882Z"
}
],
"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%3A433546322383996794
Response
Status: 200 OK
[
{
"id": "433546322449008509",
"administration_id": 123,
"contact_id": "433546322383996794",
"contact": {
"id": "433546322383996794",
"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": "2024-09-30T07:40:14.320Z",
"updated_at": "2024-09-30T07:40:14.320Z",
"version": 1727682014,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/44c0d818a6fec9c799c14d56b7dd194f9f19aedf5d5fc8ad6c8b101b988ddc9c/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:14.382Z",
"updated_at": "2024-09-30T07:40:14.388Z",
"version": 1727682014,
"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": "433546322451105662",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:14.384Z",
"updated_at": "2024-09-30T07:40:14.384Z"
},
{
"id": "433546322453202815",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:14.386Z",
"updated_at": "2024-09-30T07:40:14.386Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:14.391Z",
"updated_at": "2024-09-30T07:40:14.391Z"
}
],
"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": "433546323140020139",
"administration_id": 123,
"contact_id": "433546322998462369",
"contact": {
"id": "433546322998462369",
"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": "2024-09-30T07:40:14.905Z",
"updated_at": "2024-09-30T07:40:14.905Z",
"version": 1727682014,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3be7c94858d5461279bacd089f49cbfcc6429c671606a556a2fcfeee69c2c34a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:15.041Z",
"updated_at": "2024-09-30T07:40:15.047Z",
"version": 1727682015,
"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": "433546323142117292",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:15.043Z",
"updated_at": "2024-09-30T07:40:15.043Z"
},
{
"id": "433546323144214445",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:15.045Z",
"updated_at": "2024-09-30T07:40:15.045Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:15.049Z",
"updated_at": "2024-09-30T07:40:15.049Z"
}
],
"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": "433546323465078719",
"administration_id": 123,
"contact_id": "433546323366512569",
"contact": {
"id": "433546323366512569",
"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": "2024-09-30T07:40:15.257Z",
"updated_at": "2024-09-30T07:40:15.257Z",
"version": 1727682015,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6807fd9ff5269be5071bc4f0695a3b09daf2cee4336b7c0b1a56ac3decfcff08/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:15.351Z",
"updated_at": "2024-09-30T07:40:15.357Z",
"version": 1727682015,
"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": "433546323467175872",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:15.353Z",
"updated_at": "2024-09-30T07:40:15.353Z"
},
{
"id": "433546323469273025",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:15.355Z",
"updated_at": "2024-09-30T07:40:15.355Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:15.359Z",
"updated_at": "2024-09-30T07:40:15.359Z"
}
],
"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 is too big",
"symbolic": {
"per_page": "max"
}
}
List all IDs and versions
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": "433546326810035319",
"version": 1727682018
},
{
"id": "433546326754460784",
"version": 1727682018
}
]
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": "433546326951593088",
"version": 1727682018
}
]
Fetch recurring sales invoices with given IDs
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
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/433546324404602852.json?
Response
Status: 200 OK
{
"id": "433546324404602852",
"administration_id": 123,
"contact_id": "433546324347979745",
"contact": {
"id": "433546324347979745",
"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": "2024-09-30T07:40:16.192Z",
"updated_at": "2024-09-30T07:40:16.192Z",
"version": 1727682016,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3223686461d9ac69cf71ebf7202daf5443cb77c1c1927a532208ec334d7bc424/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:16.247Z",
"updated_at": "2024-09-30T07:40:16.252Z",
"version": 1727682016,
"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": "433546324406700005",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:16.249Z",
"updated_at": "2024-09-30T07:40:16.249Z"
},
{
"id": "433546324407748582",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:16.251Z",
"updated_at": "2024-09-30T07:40:16.251Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:16.254Z",
"updated_at": "2024-09-30T07:40:16.254Z"
}
],
"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
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 createdfrequency_type: the type of frequency you want to use, for examplemonthfrequency: defines the actual frequency, e.g.frequency=2andfrequency_type=monthwill create an invoice every 2 monthshas_desired_count: whether or not the desired count should take effectdesired_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 |
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: |
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":433546325057864716,"invoice_date":"2030-01-01","details_attributes":{"0":{"description":"Table","price":"10.5","tax_rate_id":433546325073593359,"ledger_account_id":433546325085127697}}}}' \
https://moneybird.com/api/v2/123/recurring_sales_invoices.json
Response
Status: 201 Created
{
"id": "433546325164819475",
"administration_id": 123,
"contact_id": "433546325057864716",
"contact": {
"id": "433546325057864716",
"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": "2024-09-30T07:40:16.870Z",
"updated_at": "2024-09-30T07:40:16.870Z",
"version": 1727682016,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f1a1306e3a28366bba2ed85af25429c763ae1ba9cea330c40b05cd266de9d5f5/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"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": "2024-09-30T07:40:16.972Z",
"updated_at": "2024-09-30T07:40:16.976Z",
"version": 1727682016,
"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": "433546325165868052",
"administration_id": 123,
"tax_rate_id": "433546325073593359",
"ledger_account_id": "433546325085127697",
"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": "2024-09-30T07:40:16.974Z",
"updated_at": "2024-09-30T07:40:16.974Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:16.977Z",
"updated_at": "2024-09-30T07:40:16.977Z"
}
],
"subscription": null
}
Updates a recurring sales invoice
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/433546325636678703.json
Response
Status: 200 OK
{
"id": "433546325636678703",
"administration_id": 123,
"contact_id": "433546325575861292",
"contact": {
"id": "433546325575861292",
"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": "2024-09-30T07:40:17.363Z",
"updated_at": "2024-09-30T07:40:17.363Z",
"version": 1727682017,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4913c3ec38ad93573298e0695e74b580a6ac35a851bbed4360de63db9025205c/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:17.422Z",
"updated_at": "2024-09-30T07:40:17.488Z",
"version": 1727682017,
"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": "433546325638775856",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:17.424Z",
"updated_at": "2024-09-30T07:40:17.424Z"
},
{
"id": "433546325640873009",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:17.426Z",
"updated_at": "2024-09-30T07:40:17.426Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:17.430Z",
"updated_at": "2024-09-30T07:40:17.430Z"
}
],
"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":433546325870511161,"price":10.0}}}}' \
https://moneybird.com/api/v2/123/recurring_sales_invoices/433546325868414008.json
Response
Status: 200 OK
{
"id": "433546325868414008",
"administration_id": 123,
"contact_id": "433546325820179509",
"contact": {
"id": "433546325820179509",
"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": "2024-09-30T07:40:17.597Z",
"updated_at": "2024-09-30T07:40:17.597Z",
"version": 1727682017,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/54f21d9611bb418d3ecd79d0657f0e87f2a463772e05641f0b30cfdf9825c8dc/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "433546158700234574",
"start_date": "2024-10-01",
"invoice_date": "2024-10-01",
"last_date": "2024-10-01",
"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": "2024-09-30T07:40:17.644Z",
"updated_at": "2024-09-30T07:40:17.709Z",
"version": 1727682017,
"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": "433546325870511161",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:17.646Z",
"updated_at": "2024-09-30T07:40:17.707Z"
},
{
"id": "433546325873656890",
"administration_id": 123,
"tax_rate_id": "433546158515685191",
"ledger_account_id": "433546158461159223",
"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": "2024-09-30T07:40:17.648Z",
"updated_at": "2024-09-30T07:40:17.648Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 1727681857838,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:17.652Z",
"updated_at": "2024-09-30T07:40:17.652Z"
}
],
"subscription": null
}
Destroy or deactivate a recurring sales invoice
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/433546326556279910.json
Response
Adds note to entity
Parameters
| Parameter | Type | Description |
|---|---|---|
note[note] |
String |
Required. Text for the note or to-do. |
note[todo] |
Boolean |
If |
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":433546327473783976,"todo":true}}' \
https://moneybird.com/api/v2/123/recurring_sales_invoices/433546327454909604/notes.json
Response
Status: 201 Created
{
"id": "433546327534601386",
"administration_id": 123,
"entity_id": "433546327454909604",
"entity_type": "RecurringSalesInvoice",
"user_id": 1727681857838,
"assignee_id": "433546327473783976",
"todo": true,
"note": "Text of the note",
"completed_at": null,
"completed_by_id": null,
"todo_type": null,
"data": {
},
"created_at": "2024-09-30T07:40:19.232Z",
"updated_at": "2024-09-30T07:40:19.232Z"
}
Destroys note from entity
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/433546327633167537/notes/433546327646799029.json