Estimates
List all estimates
Returns a paginated list of all estimates in the administration.
The filter argument allows you to filter on the list of estimates. Filters are a combination of keys and values,
separated by a comma: period:this_year,state:all. The available options for filtering are:
| Filter | Type | Default | Description |
| state | String |
all |
all, draft, open, late, accepted, rejected, billed or archived |
| period | String |
this_year |
This can either be the description of a period (this_month, prev_month, next_month, this_quarter, prev_quarter, next_quarter, this_year, prev_year, next_year) or a custom period (201301..201302, 20130101..20130131) |
| contact_id | Integer |
Filters estimates by a single contact | |
| workflow_id | Integer |
Filters estimates by a single workflow |
You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:draft|scheduled.
Parameters
| Parameter | Type | Description |
|---|---|---|
filter |
String |
See table above for detailed options. |
Example: returns all estimates of an administration
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates.json?
Response
Status: 200 OK
[
{
"id": "416087550101292055",
"administration_id": 123,
"contact_id": "416087549435446277",
"contact": {
"id": "416087549435446277",
"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": "",
"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-03-21T14:40:30.993Z",
"updated_at": "2024-03-21T14:40:30.993Z",
"version": 1711032030,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4d6c0de34c9c5d59c193cd43dfe55f7fa399ea426ddf88ac335347df87e7a967/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0004",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:31.628Z",
"updated_at": "2024-03-21T14:40:31.756Z",
"public_view_code": "283640",
"public_view_code_expires_at": "2024-06-21T14:40:31.695Z",
"version": 1711032031,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087550104437784",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:31.631Z",
"updated_at": "2024-03-21T14:40:31.754Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/ae80f71c805a9225be78eb36ead1f8e6f20466381cf8e1eae19760bee36c3026/4d6c0de34c9c5d59c193cd43dfe55f7fa399ea426ddf88ac335347df87e7a967",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:31.639Z",
"updated_at": "2024-03-21T14:40:31.639Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:31.770Z",
"updated_at": "2024-03-21T14:40:31.770Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087549942957075",
"administration_id": 123,
"contact_id": "416087549435446277",
"contact": {
"id": "416087549435446277",
"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": "",
"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-03-21T14:40:30.993Z",
"updated_at": "2024-03-21T14:40:30.993Z",
"version": 1711032030,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4d6c0de34c9c5d59c193cd43dfe55f7fa399ea426ddf88ac335347df87e7a967/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0003",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:31.478Z",
"updated_at": "2024-03-21T14:40:31.558Z",
"public_view_code": "971042",
"public_view_code_expires_at": "2024-06-21T14:40:31.519Z",
"version": 1711032031,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087549946102804",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:31.480Z",
"updated_at": "2024-03-21T14:40:31.557Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/3b29139ca99a44bc0c11a67df86cacc40924315f1718375d042c9057d98f24b1/4d6c0de34c9c5d59c193cd43dfe55f7fa399ea426ddf88ac335347df87e7a967",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:31.485Z",
"updated_at": "2024-03-21T14:40:31.485Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:31.568Z",
"updated_at": "2024-03-21T14:40:31.568Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087549789864975",
"administration_id": 123,
"contact_id": "416087549435446277",
"contact": {
"id": "416087549435446277",
"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": "",
"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-03-21T14:40:30.993Z",
"updated_at": "2024-03-21T14:40:30.993Z",
"version": 1711032030,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4d6c0de34c9c5d59c193cd43dfe55f7fa399ea426ddf88ac335347df87e7a967/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0002",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:31.331Z",
"updated_at": "2024-03-21T14:40:31.422Z",
"public_view_code": "884545",
"public_view_code_expires_at": "2024-06-21T14:40:31.375Z",
"version": 1711032031,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087549791962128",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:31.334Z",
"updated_at": "2024-03-21T14:40:31.420Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/0d5a864576b3625c167b41d19ad2fb7435110617112fe1ef13345853feba876c/4d6c0de34c9c5d59c193cd43dfe55f7fa399ea426ddf88ac335347df87e7a967",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:31.339Z",
"updated_at": "2024-03-21T14:40:31.339Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:31.432Z",
"updated_at": "2024-03-21T14:40:31.432Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns all estimates filtered on period
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates.json?filter=period%3Athis_month
Response
Status: 200 OK
[
{
"id": "416087551026136114",
"administration_id": 123,
"contact_id": "416087550496605216",
"contact": {
"id": "416087550496605216",
"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": "",
"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-03-21T14:40:32.005Z",
"updated_at": "2024-03-21T14:40:32.005Z",
"version": 1711032032,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f4db80ab96bce1a81ba36fe581e27338bbcfdbcbc891d6b1f363d0c582e6058a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0004",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:32.509Z",
"updated_at": "2024-03-21T14:40:32.607Z",
"public_view_code": "638035",
"public_view_code_expires_at": "2024-06-21T14:40:32.561Z",
"version": 1711032032,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087551028233267",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:32.512Z",
"updated_at": "2024-03-21T14:40:32.606Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/e39f794979e4b51587f3766504f15f03bf35f584ef8bf2846813ce579d3d9d09/f4db80ab96bce1a81ba36fe581e27338bbcfdbcbc891d6b1f363d0c582e6058a",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:32.518Z",
"updated_at": "2024-03-21T14:40:32.518Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:32.618Z",
"updated_at": "2024-03-21T14:40:32.618Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087550870946862",
"administration_id": 123,
"contact_id": "416087550496605216",
"contact": {
"id": "416087550496605216",
"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": "",
"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-03-21T14:40:32.005Z",
"updated_at": "2024-03-21T14:40:32.005Z",
"version": 1711032032,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f4db80ab96bce1a81ba36fe581e27338bbcfdbcbc891d6b1f363d0c582e6058a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0003",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:32.362Z",
"updated_at": "2024-03-21T14:40:32.446Z",
"public_view_code": "769001",
"public_view_code_expires_at": "2024-06-21T14:40:32.404Z",
"version": 1711032032,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087550873044015",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:32.364Z",
"updated_at": "2024-03-21T14:40:32.445Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/dea91bd19bd2bac13765e19937a14d79839ffc18eebb367a2cf1760bc4e82907/f4db80ab96bce1a81ba36fe581e27338bbcfdbcbc891d6b1f363d0c582e6058a",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:32.370Z",
"updated_at": "2024-03-21T14:40:32.370Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:32.458Z",
"updated_at": "2024-03-21T14:40:32.458Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087550723097642",
"administration_id": 123,
"contact_id": "416087550496605216",
"contact": {
"id": "416087550496605216",
"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": "",
"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-03-21T14:40:32.005Z",
"updated_at": "2024-03-21T14:40:32.005Z",
"version": 1711032032,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f4db80ab96bce1a81ba36fe581e27338bbcfdbcbc891d6b1f363d0c582e6058a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0002",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:32.221Z",
"updated_at": "2024-03-21T14:40:32.304Z",
"public_view_code": "183478",
"public_view_code_expires_at": "2024-06-21T14:40:32.262Z",
"version": 1711032032,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087550725194795",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:32.223Z",
"updated_at": "2024-03-21T14:40:32.303Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/af5b9f3db072555fa37167e46a5b9d494cfa0f5d43bb00ca1935ee8f82fc60ff/f4db80ab96bce1a81ba36fe581e27338bbcfdbcbc891d6b1f363d0c582e6058a",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:32.229Z",
"updated_at": "2024-03-21T14:40:32.229Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:32.315Z",
"updated_at": "2024-03-21T14:40:32.315Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns all estimates filtered on state
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates.json?filter=state%3Aopen
Response
Status: 200 OK
[
{
"id": "416087551918474317",
"administration_id": 123,
"contact_id": "416087551343854651",
"contact": {
"id": "416087551343854651",
"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": "",
"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-03-21T14:40:32.813Z",
"updated_at": "2024-03-21T14:40:32.813Z",
"version": 1711032032,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/63638d4910e1c2f97dedc828b0f24740d01496b66f6956a28abb3768796f8669/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0004",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:33.361Z",
"updated_at": "2024-03-21T14:40:33.438Z",
"public_view_code": "934105",
"public_view_code_expires_at": "2024-06-21T14:40:33.401Z",
"version": 1711032033,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087551921620046",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:33.364Z",
"updated_at": "2024-03-21T14:40:33.437Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/c57404e34a47a8c42ca4f74c35e75a5269937a28270a4d01cecbb1be15063d1b/63638d4910e1c2f97dedc828b0f24740d01496b66f6956a28abb3768796f8669",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:33.370Z",
"updated_at": "2024-03-21T14:40:33.370Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:33.448Z",
"updated_at": "2024-03-21T14:40:33.448Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087551762236489",
"administration_id": 123,
"contact_id": "416087551343854651",
"contact": {
"id": "416087551343854651",
"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": "",
"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-03-21T14:40:32.813Z",
"updated_at": "2024-03-21T14:40:32.813Z",
"version": 1711032032,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/63638d4910e1c2f97dedc828b0f24740d01496b66f6956a28abb3768796f8669/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0003",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:33.211Z",
"updated_at": "2024-03-21T14:40:33.305Z",
"public_view_code": "612379",
"public_view_code_expires_at": "2024-06-21T14:40:33.259Z",
"version": 1711032033,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087551764333642",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:33.214Z",
"updated_at": "2024-03-21T14:40:33.304Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/d072bb34466e62e817c8dc2115e1c256a87ea181a78999e6c959c71b15b0579c/63638d4910e1c2f97dedc828b0f24740d01496b66f6956a28abb3768796f8669",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:33.220Z",
"updated_at": "2024-03-21T14:40:33.220Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:33.315Z",
"updated_at": "2024-03-21T14:40:33.315Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087551612290117",
"administration_id": 123,
"contact_id": "416087551343854651",
"contact": {
"id": "416087551343854651",
"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": "",
"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-03-21T14:40:32.813Z",
"updated_at": "2024-03-21T14:40:32.813Z",
"version": 1711032032,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/63638d4910e1c2f97dedc828b0f24740d01496b66f6956a28abb3768796f8669/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0002",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:33.069Z",
"updated_at": "2024-03-21T14:40:33.154Z",
"public_view_code": "887255",
"public_view_code_expires_at": "2024-06-21T14:40:33.112Z",
"version": 1711032033,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087551614387270",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:33.071Z",
"updated_at": "2024-03-21T14:40:33.153Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/7e8fb5a39438e77bc9db232d7bf05a26ec96c146b247f9b2710e3aa95e58c21c/63638d4910e1c2f97dedc828b0f24740d01496b66f6956a28abb3768796f8669",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:33.078Z",
"updated_at": "2024-03-21T14:40:33.078Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:33.164Z",
"updated_at": "2024-03-21T14:40:33.164Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns paginated estimates on page 1
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates.json?per_page=1
Response
Status: 200 OK
[
{
"id": "416087552711197800",
"administration_id": 123,
"contact_id": "416087552176424022",
"contact": {
"id": "416087552176424022",
"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": "",
"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-03-21T14:40:33.607Z",
"updated_at": "2024-03-21T14:40:33.607Z",
"version": 1711032033,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/997cb9809162cabfc0a80ea75b5430256d5399380fd2927e7885334c6b7054ce/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0004",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:34.117Z",
"updated_at": "2024-03-21T14:40:34.201Z",
"public_view_code": "515108",
"public_view_code_expires_at": "2024-06-21T14:40:34.159Z",
"version": 1711032034,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087552713294953",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:34.119Z",
"updated_at": "2024-03-21T14:40:34.200Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/a836688944cf11eb4ce4c7241df265b2d0f4103f08ec15b1ada4330306798d07/997cb9809162cabfc0a80ea75b5430256d5399380fd2927e7885334c6b7054ce",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:34.125Z",
"updated_at": "2024-03-21T14:40:34.125Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:34.211Z",
"updated_at": "2024-03-21T14:40:34.211Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns paginated estimates on page 2
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates.json?page=2&per_page=1
Response
Status: 200 OK
[
{
"id": "416087553370752127",
"administration_id": 123,
"contact_id": "416087552978584689",
"contact": {
"id": "416087552978584689",
"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": "",
"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-03-21T14:40:34.372Z",
"updated_at": "2024-03-21T14:40:34.372Z",
"version": 1711032034,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d9161064eeb6105bebb26c71779d1a6f7f77f109c5b3f430b7c413a6e880d0c3/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0003",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:34.746Z",
"updated_at": "2024-03-21T14:40:34.837Z",
"public_view_code": "781464",
"public_view_code_expires_at": "2024-06-21T14:40:34.792Z",
"version": 1711032034,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087553373897856",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:34.749Z",
"updated_at": "2024-03-21T14:40:34.835Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/439e06e948c4504753bdafb76876ad946bba4e44f6c604ea2f78894fcb1eb139/d9161064eeb6105bebb26c71779d1a6f7f77f109c5b3f430b7c413a6e880d0c3",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:34.755Z",
"updated_at": "2024-03-21T14:40:34.755Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:34.847Z",
"updated_at": "2024-03-21T14:40:34.847Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns an error when too many estimates are requested
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates.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 estimates in the administration. The list contains the id and version of the estimate.
If the version of the estimate is newer than the version you have stored locally, use the POST
variant to fetch estimates 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/estimates/synchronization.json?
Response
Status: 200 OK
[
{
"id": "416087564404917760",
"version": 1711032045
},
{
"id": "416087564241339899",
"version": 1711032045
}
]
Example: retrieves the ids for synchronization filtered on state
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates/synchronization.json?filter=state%3Aopen
Response
Status: 200 OK
[
{
"id": "416087564558009866",
"version": 1711032045
}
]
Fetch estimates with given ids
Given a list of estimate ids, returns the estimate information belonging to the estimates. Returns a maximum of 100 estimates, even if more ids are provided.
Parameters
| Parameter | Type | Description |
|---|---|---|
ids |
Array[integer] |
Required |
Example: retrieves estimates by given ids
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"ids":[416087564874679833,416087565027771934]}' \
https://moneybird.com/api/v2/123/estimates/synchronization.json
Response
Status: 200 OK
[
{
"id": "416087564874679833",
"administration_id": 123,
"contact_id": "416087564822251028",
"contact": {
"id": "416087564822251028",
"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": "",
"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-03-21T14:40:45.667Z",
"updated_at": "2024-03-21T14:40:45.667Z",
"version": 1711032045,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d47b0b00bb1422ef82a06a83f75a6fd7e496606517cdfa226e9391049550dfd2/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087564833785367",
"contact_person": {
"id": null,
"contact_id": "416087564822251028",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:45.677Z",
"updated_at": "2024-03-21T14:40:45.677Z",
"version": 1711032045
},
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:45.717Z",
"updated_at": "2024-03-21T14:40:45.801Z",
"public_view_code": "234689",
"public_view_code_expires_at": "2024-06-21T14:40:45.761Z",
"version": 1711032045,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087564877825562",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:45.720Z",
"updated_at": "2024-03-21T14:40:45.800Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/13a5a9a3b237a696e60101c876438d3d3b8ecb2a472e84ff05757a3f6bb773cd/d47b0b00bb1422ef82a06a83f75a6fd7e496606517cdfa226e9391049550dfd2",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:45.726Z",
"updated_at": "2024-03-21T14:40:45.726Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:45.812Z",
"updated_at": "2024-03-21T14:40:45.812Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087565027771934",
"administration_id": 123,
"contact_id": "416087564822251028",
"contact": {
"id": "416087564822251028",
"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": "",
"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-03-21T14:40:45.667Z",
"updated_at": "2024-03-21T14:40:45.667Z",
"version": 1711032045,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d47b0b00bb1422ef82a06a83f75a6fd7e496606517cdfa226e9391049550dfd2/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087564833785367",
"contact_id": "416087564822251028",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:45.677Z",
"updated_at": "2024-03-21T14:40:45.677Z",
"version": 1711032045
}
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": null,
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 2,
"state": "draft",
"estimate_date": null,
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": null,
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:45.863Z",
"updated_at": "2024-03-21T14:40:45.867Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032045,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087565029869087",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:45.865Z",
"updated_at": "2024-03-21T14:40:45.865Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/a7db9cc48e495cda24443e29c174a542818aca7e67121af74a8d151d89ce081d/d47b0b00bb1422ef82a06a83f75a6fd7e496606517cdfa226e9391049550dfd2",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:45.872Z",
"updated_at": "2024-03-21T14:40:45.872Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Get an estimate by id
Returns all information about an estimate.
Parameters
| Parameter | Type | Description |
|---|---|---|
includes |
Array |
Example: returns estimate by given id
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates/416087554762212524.json?
Response
Status: 200 OK
{
"id": "416087554762212524",
"administration_id": 123,
"contact_id": "416087554701395111",
"contact": {
"id": "416087554701395111",
"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": "",
"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-03-21T14:40:36.015Z",
"updated_at": "2024-03-21T14:40:36.015Z",
"version": 1711032036,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/34b962935cfae36e1bc3086a60e5c5f9050c461ae65da372f0fe93ee72923a7a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087554715026602",
"contact_person": {
"id": null,
"contact_id": "416087554701395111",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:36.027Z",
"updated_at": "2024-03-21T14:40:36.027Z",
"version": 1711032036
},
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:36.073Z",
"updated_at": "2024-03-21T14:40:36.159Z",
"public_view_code": "698643",
"public_view_code_expires_at": "2024-06-21T14:40:36.115Z",
"version": 1711032036,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087554764309677",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:36.075Z",
"updated_at": "2024-03-21T14:40:36.157Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/81fb6a09753d5d9057d47085f97392be2bdd371498942a1464d84ab2ef7cb3c3/34b962935cfae36e1bc3086a60e5c5f9050c461ae65da372f0fe93ee72923a7a",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:36.081Z",
"updated_at": "2024-03-21T14:40:36.081Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:36.171Z",
"updated_at": "2024-03-21T14:40:36.171Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: responds with a 404 code when estimate does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates/0.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Get an estimate by estimate_id
Returns all information about an estimate with the given estimate id
Parameters
| Parameter | Type | Description |
|---|---|---|
estimate_id |
String |
Required Should be a valid estimate id. Should be unique for the administration. |
Example: returns estimate by given estimate_id
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates/find_by_estimate_id/2024-0001.json?
Response
Status: 200 OK
{
"id": "416087555317957828",
"administration_id": 123,
"contact_id": "416087555259237567",
"contact": {
"id": "416087555259237567",
"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": "",
"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-03-21T14:40:36.547Z",
"updated_at": "2024-03-21T14:40:36.547Z",
"version": 1711032036,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5ecda9fada6a08b335d2c4b8726f02fc4d0d1071b662dd6d68407819396eb3b6/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087555272869058",
"contact_person": {
"id": null,
"contact_id": "416087555259237567",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:36.560Z",
"updated_at": "2024-03-21T14:40:36.560Z",
"version": 1711032036
},
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:36.603Z",
"updated_at": "2024-03-21T14:40:36.690Z",
"public_view_code": "299295",
"public_view_code_expires_at": "2024-06-21T14:40:36.645Z",
"version": 1711032036,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087555320054981",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:36.605Z",
"updated_at": "2024-03-21T14:40:36.689Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/f75d938fc1c59655bd072e322d3cbd4f50fbefe4405ce48487e61f05fdac07bd/5ecda9fada6a08b335d2c4b8726f02fc4d0d1071b662dd6d68407819396eb3b6",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:36.611Z",
"updated_at": "2024-03-21T14:40:36.611Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:36.702Z",
"updated_at": "2024-03-21T14:40:36.702Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: responds with a 404 code when estimate does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates/find_by_estimate_id/0.json?
Response
Status: 404 Not Found
{
"error": "Estimate with estimate_id: 0 was not found",
"symbolic": {
"estimate_id": "not_found"
}
}
Download estimate PDF by id
Redirects to the download URL of the estimate as PDF. The link is valid for 30 seconds.
Parameters
| Parameter | Type | Description |
|---|---|---|
media |
String |
In case you want to hide sender address and logo you can set this to ‘stationery’. |
Example: returns estimate by given id as PDF
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates/416087555853780186/download_pdf.json?
Response
Status: 302 Found
"This resource has been moved temporarily to https://storage.moneybird.dev/abd2583d8ba13e1f7236f8899f659844b298448b9f9c2e5c580e4771fea2fb0e/2a1c5e6c04662cf43e350405c10aacbe8d542b3afdf2f3197aa59b2225573fac/download."
Example: returns 404 when estimate does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/estimates/1234321/download_pdf.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Creates a new estimate
Parameters
| Parameter | Type | Description |
|---|---|---|
estimate[contact_id] |
Integer |
Should be a valid contact id. |
estimate[contact_person_id] |
Integer |
Should be a valid contact person id. |
estimate[document_style_id] |
Integer |
Required Default document style is used when value is not provided. Should be a valid document style id. |
estimate[workflow_id] |
Integer |
Required If value is not provided, the workflow saved in the contact is used. If the contact doesn’t have a default workflow, the administration’s default workflow is used. Should be a valid workflow id. |
estimate[reference] |
String |
|
estimate[estimate_date] |
String |
|
estimate[estimate_sequence_id] |
String |
|
estimate[remove_estimate_sequence_id] |
Boolean |
|
estimate[language] |
String |
Can be |
estimate[currency] |
String |
ISO three-character currency code, e.g. EUR or USD. |
estimate[prices_are_incl_tax] |
Boolean |
|
estimate[show_tax] |
Boolean |
|
estimate[first_due_interval] |
Integer |
|
estimate[pre_text] |
String |
|
estimate[post_text] |
String |
|
estimate[discount] |
Decimal |
Discount percentage, e.g. 10,0%. Should be a number 0 <= n <= 100. |
estimate[original_sales_invoice_id] |
Integer |
|
estimate[details_attributes][id] |
Integer |
|
estimate[details_attributes][description] |
String |
|
estimate[details_attributes][period] |
String |
String with a date range: |
estimate[details_attributes][price] |
Decimal |
Both a decimal and a string ‘10,95’ are accepted. |
estimate[details_attributes][amount] |
String |
|
estimate[details_attributes][tax_rate_id] |
Integer |
Should be a valid tax rate id. |
estimate[details_attributes][ledger_account_id] |
Integer |
Should be a valid ledger account id. |
estimate[details_attributes][project_id] |
Integer |
Should be a valid project id. |
estimate[details_attributes][product_id] |
Integer |
Should be a valid product id. |
estimate[details_attributes][row_order] |
Integer |
|
estimate[details_attributes][is_optional] |
Boolean |
|
estimate[details_attributes][is_selected] |
Boolean |
|
estimate[details_attributes][_destroy] |
Boolean |
|
estimate[custom_fields_attributes][id] |
Integer |
Required |
estimate[custom_fields_attributes][value] |
String |
Required |
Example: creates a new estimate
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"estimate":{"contact_id":416087557637407979,"reference":"Estimate Reference"}}' \
https://moneybird.com/api/v2/123/estimates.json
Response
Status: 201 Created
{
"id": "416087557889066229",
"administration_id": 123,
"contact_id": "416087557637407979",
"contact": {
"id": "416087557637407979",
"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": "",
"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-03-21T14:40:38.815Z",
"updated_at": "2024-03-21T14:40:38.815Z",
"version": 1711032038,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ad9d91e33fc0341ef575a1b4ae58ccec01ede54481ae2bf3617b7829b0559d8c/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087557652088046",
"contact_id": "416087557637407979",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:38.828Z",
"updated_at": "2024-03-21T14:40:38.828Z",
"version": 1711032038
}
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": null,
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 2,
"state": "draft",
"estimate_date": null,
"due_date": "2024-04-04",
"reference": "Estimate Reference",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": null,
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:39.055Z",
"updated_at": "2024-03-21T14:40:39.055Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032039,
"pre_text": "Geachte {recipient.name},\n\nHierbij ontvangt u van ons de prijsopgave {document.estimate_id} voor de onderstaande diensten.",
"post_text": "We hopen u hiermee voldoende geïnformeerd te hebben.\n\nMet vriendelijke groet,\n\n{company.company_name}",
"details": [
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "0.0",
"total_price_excl_tax_base": "0.0",
"total_price_incl_tax": "0.0",
"total_price_incl_tax_base": "0.0",
"total_discount": 0,
"url": "http://moneybird.dev/123/estimates/5b507d4ea4ec2ff380ee305c0c3b06e9829f85cb9fe311919da869ed97802a3f/ad9d91e33fc0341ef575a1b4ae58ccec01ede54481ae2bf3617b7829b0559d8c",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:39.060Z",
"updated_at": "2024-03-21T14:40:39.060Z"
}
],
"tax_totals": [
]
}
Updates an estimate
When updating an estimate, provide only the attributes you want to update. The other attributes will not be changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
estimate[contact_id] |
Integer |
Should be a valid contact id. |
estimate[contact_person_id] |
Integer |
Should be a valid contact person id. |
estimate[update_contact] |
Boolean |
|
estimate[document_style_id] |
Integer |
Default document style is used when value is not provided. Should be a valid document style id. |
estimate[workflow_id] |
Integer |
If value is not provided, the workflow saved in the contact is used. If the contact doesn’t have a default workflow, the administration’s default workflow is used. Should be a valid workflow id. |
estimate[reference] |
String |
|
estimate[estimate_date] |
String |
|
estimate[estimate_sequence_id] |
String |
|
estimate[remove_estimate_sequence_id] |
Boolean |
|
estimate[language] |
String |
Can be |
estimate[currency] |
String |
ISO three-character currency code, e.g. EUR or USD. |
estimate[prices_are_incl_tax] |
Boolean |
|
estimate[show_tax] |
Boolean |
|
estimate[first_due_interval] |
Integer |
|
estimate[pre_text] |
String |
|
estimate[post_text] |
String |
|
estimate[discount] |
Decimal |
Discount percentage, e.g. 10,0%. Should be a number 0 <= n <= 100. |
estimate[original_sales_invoice_id] |
Integer |
|
estimate[details_attributes][id] |
Integer |
|
estimate[details_attributes][description] |
String |
|
estimate[details_attributes][period] |
String |
String with a date range: |
estimate[details_attributes][price] |
Decimal |
Both a decimal and a string ‘10,95’ are accepted. |
estimate[details_attributes][amount] |
String |
|
estimate[details_attributes][tax_rate_id] |
Integer |
Should be a valid tax rate id. |
estimate[details_attributes][ledger_account_id] |
Integer |
Should be a valid ledger account id. |
estimate[details_attributes][project_id] |
Integer |
Should be a valid project id. |
estimate[details_attributes][product_id] |
Integer |
Should be a valid product id. |
estimate[details_attributes][row_order] |
Integer |
|
estimate[details_attributes][is_optional] |
Boolean |
|
estimate[details_attributes][is_selected] |
Boolean |
|
estimate[details_attributes][_destroy] |
Boolean |
|
estimate[custom_fields_attributes][id] |
Integer |
Required |
estimate[custom_fields_attributes][value] |
String |
Required |
Example: updates the discount
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"estimate":{"reference":"Updated Reference"}}' \
https://moneybird.com/api/v2/123/estimates/416087558353585421.json
Response
Status: 200 OK
{
"id": "416087558353585421",
"administration_id": 123,
"contact_id": "416087558296962312",
"contact": {
"id": "416087558296962312",
"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": "",
"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-03-21T14:40:39.444Z",
"updated_at": "2024-03-21T14:40:39.444Z",
"version": 1711032039,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4dc50f96205d96db7a0f4c1f3e0028de73cda4438ac82050388f219c73b0ffd1/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087558309545227",
"contact_person": {
"id": null,
"contact_id": "416087558296962312",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:39.456Z",
"updated_at": "2024-03-21T14:40:39.456Z",
"version": 1711032039
},
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Updated Reference",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:39.498Z",
"updated_at": "2024-03-21T14:40:39.687Z",
"public_view_code": "838555",
"public_view_code_expires_at": "2024-06-21T14:40:39.543Z",
"version": 1711032039,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087558355682574",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:39.500Z",
"updated_at": "2024-03-21T14:40:39.584Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/7beda53a8777eca36fb70b72671fee0db79bde0e87cfc4fc2efc7f061783bfaf/4dc50f96205d96db7a0f4c1f3e0028de73cda4438ac82050388f219c73b0ffd1",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:39.507Z",
"updated_at": "2024-03-21T14:40:39.507Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:39.596Z",
"updated_at": "2024-03-21T14:40:39.596Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_updated",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"reference": [
"Project X",
"Updated Reference"
],
"updated_at": [
"2024-03-21T15:40:39.586+01:00",
"2024-03-21T15:40:39.687+01:00"
]
},
"created_at": "2024-03-21T14:40:39.690Z",
"updated_at": "2024-03-21T14:40:39.690Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: updates estimate details
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"estimate":{"details_attributes":{"0":{"description":"Detail description","price":99,"amount":1,"tax_rate_id":416087461198825343,"ledger_account_id":416087461088724843},"1":{"id":416087558699615515,"_destroy":true}}}}' \
https://moneybird.com/api/v2/123/estimates/416087558697518362.json
Response
Status: 200 OK
{
"id": "416087558697518362",
"administration_id": 123,
"contact_id": "416087558641943829",
"contact": {
"id": "416087558641943829",
"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": "",
"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-03-21T14:40:39.773Z",
"updated_at": "2024-03-21T14:40:39.773Z",
"version": 1711032039,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6fc23e79efa0a7af24ff5fd520cd1032157dcbe4bf1131112c745ca59d1551c8/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087558654526744",
"contact_person": {
"id": null,
"contact_id": "416087558641943829",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:39.785Z",
"updated_at": "2024-03-21T14:40:39.785Z",
"version": 1711032039
},
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:39.826Z",
"updated_at": "2024-03-21T14:40:40.039Z",
"public_view_code": "685956",
"public_view_code_expires_at": "2024-06-21T14:40:39.868Z",
"version": 1711032040,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087558918767903",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1",
"amount_decimal": "1.0",
"description": "Detail description",
"price": "99.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "99.0",
"total_price_excl_tax_with_discount_base": "99.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:40.037Z",
"updated_at": "2024-03-21T14:40:40.037Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "99.0",
"total_price_excl_tax_base": "99.0",
"total_price_incl_tax": "119.79",
"total_price_incl_tax_base": "119.79",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/d12f5546276f5e6699047c53771744abab6f3d813bc7fe15ade2d1ec6b1617d3/6fc23e79efa0a7af24ff5fd520cd1032157dcbe4bf1131112c745ca59d1551c8",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:39.834Z",
"updated_at": "2024-03-21T14:40:39.834Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:39.938Z",
"updated_at": "2024-03-21T14:40:39.938Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_updated",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"total_price_excl_tax": [
"300.0",
"99.0"
],
"total_price_excl_tax_base": [
"300.0",
"99.0"
],
"total_price_incl_tax": [
"363.0",
"119.79"
],
"total_price_incl_tax_base": [
"363.0",
"119.79"
],
"cached_taxes": [
[
{
"tax_rate_id": "416087461198825343",
"report_reference": "NL/1a",
"payable": true,
"debit": 0,
"credit": "63.0"
}
],
[
{
"tax_rate_id": "416087461198825343",
"report_reference": "NL/1a",
"payable": true,
"debit": 0,
"credit": "20.79"
}
]
],
"updated_at": [
"2024-03-21T15:40:39.924+01:00",
"2024-03-21T15:40:40.030+01:00"
]
},
"created_at": "2024-03-21T14:40:40.040Z",
"updated_at": "2024-03-21T14:40:40.040Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "99.0",
"taxable_amount_base": "99.0",
"tax_amount": "20.79",
"tax_amount_base": "20.79"
}
]
}
Example: responds with a 404 code when estimate does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"estimate":{"reference":"Updated Reference"}}' \
https://moneybird.com/api/v2/123/estimates/0.json
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Changes the state of an estimate
Not every state change is allowed. e.g. open to billed is accepted, draft to open is not. Note: this only changes the state and does not perform other actions like sending or billing the estimate.
Parameters
| Parameter | Type | Description |
|---|---|---|
state |
String |
Required Can be accepted, rejected, open, late, billed or archived. |
Example: changes from open to accepted
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"state":"accepted"}' \
https://moneybird.com/api/v2/123/estimates/416087559447250233/change_state.json
Response
Status: 200 OK
{
"id": "416087559447250233",
"administration_id": 123,
"contact_id": "416087559234389295",
"contact": {
"id": "416087559234389295",
"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": "",
"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-03-21T14:40:40.338Z",
"updated_at": "2024-03-21T14:40:40.338Z",
"version": 1711032040,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5c84aa90f422b3c069403aa29be777b6c33ed76776efa22e4ee8e44ec093cac5/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0002",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "accepted",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": "2024-03-21",
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:40.541Z",
"updated_at": "2024-03-21T14:40:40.701Z",
"public_view_code": "850828",
"public_view_code_expires_at": "2024-06-21T14:40:40.582Z",
"version": 1711032040,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087559449347386",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:40.543Z",
"updated_at": "2024-03-21T14:40:40.620Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/20e2a8d15791be4010d7b7c96b0e335949f106ed7ff3855421254ba3b05e7f49/5c84aa90f422b3c069403aa29be777b6c33ed76776efa22e4ee8e44ec093cac5",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:40.549Z",
"updated_at": "2024-03-21T14:40:40.549Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:40.630Z",
"updated_at": "2024-03-21T14:40:40.630Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_mark_accepted",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:40.705Z",
"updated_at": "2024-03-21T14:40:40.705Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: returns an error if estimate cannot be marked from draft to open
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"state":"open"}' \
https://moneybird.com/api/v2/123/estimates/416087560383628636/change_state.json
Response
Status: 400 Bad Request
{
"error": "State is invalid",
"symbolic": {
"state": "can_not_change_draft_to_open"
}
}
Bills an estimate
An invoice is created based on the accepted estimate.
Example: bills an accepted estimate
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087561111340411/bill_estimate.json
Response
Status: 200 OK
{
"id": "416087561350415745",
"administration_id": 123,
"contact_id": "416087560877507953",
"contact": {
"id": "416087560877507953",
"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": "",
"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-03-21T14:40:41.905Z",
"updated_at": "2024-03-21T14:40:41.905Z",
"version": 1711032041,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/252caef26f1ded1cd5db18524f3ac0d24d7f20f2dff23072de2f94452ffebb56/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087560903722356",
"contact_id": "416087560877507953",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:41.929Z",
"updated_at": "2024-03-21T14:40:41.929Z",
"version": 1711032041
}
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": null,
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 1,
"state": "draft",
"invoice_date": null,
"due_date": "2024-04-04",
"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.",
"payment_reference": null,
"short_payment_reference": null,
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": null,
"created_at": "2024-03-21T14:40:42.355Z",
"updated_at": "2024-03-21T14:40:42.361Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032042,
"details": [
{
"id": "416087561353561474",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:42.359Z",
"updated_at": "2024-03-21T14:40:42.359Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": null,
"original_estimate_id": "416087561111340411",
"url": "http://moneybird.dev/123/sales_invoices/470f511b55d10861b500478e28f0e65c0f7939e134ee0b8bdecacf1a3e53dee8/252caef26f1ded1cd5db18524f3ac0d24d7f20f2dff23072de2f94452ffebb56",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/470f511b55d10861b500478e28f0e65c0f7939e134ee0b8bdecacf1a3e53dee8/252caef26f1ded1cd5db18524f3ac0d24d7f20f2dff23072de2f94452ffebb56/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created_based_on_estimate",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"original_estimate": "2024-0002"
},
"created_at": "2024-03-21T14:40:42.365Z",
"updated_at": "2024-03-21T14:40:42.365Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: bills an open estimate
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087561722660241/bill_estimate.json
Response
Status: 200 OK
{
"id": "416087561968027031",
"administration_id": 123,
"contact_id": "416087561476244871",
"contact": {
"id": "416087561476244871",
"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": "",
"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-03-21T14:40:42.476Z",
"updated_at": "2024-03-21T14:40:42.476Z",
"version": 1711032042,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/64c0eac7e8ad78b407253b2f480c2cb18a4d16d15f1244adcd5c473e48ab16f7/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087561488827786",
"contact_id": "416087561476244871",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:40:42.487Z",
"updated_at": "2024-03-21T14:40:42.487Z",
"version": 1711032042
}
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": null,
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 1,
"state": "draft",
"invoice_date": null,
"due_date": "2024-04-04",
"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.",
"payment_reference": null,
"short_payment_reference": null,
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": null,
"created_at": "2024-03-21T14:40:42.945Z",
"updated_at": "2024-03-21T14:40:42.950Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032042,
"details": [
{
"id": "416087561971172760",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:42.948Z",
"updated_at": "2024-03-21T14:40:42.948Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": null,
"original_estimate_id": "416087561722660241",
"url": "http://moneybird.dev/123/sales_invoices/5329c0bebba68eb06dad291666d3c94f5bfb61fde6567fcb66df4a3e9e157569/64c0eac7e8ad78b407253b2f480c2cb18a4d16d15f1244adcd5c473e48ab16f7",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/5329c0bebba68eb06dad291666d3c94f5bfb61fde6567fcb66df4a3e9e157569/64c0eac7e8ad78b407253b2f480c2cb18a4d16d15f1244adcd5c473e48ab16f7/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created_based_on_estimate",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"original_estimate": "2024-0002"
},
"created_at": "2024-03-21T14:40:42.953Z",
"updated_at": "2024-03-21T14:40:42.953Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: can not bill an open estimate
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087562285745575/bill_estimate.json
Response
Status: 400 Bad Request
{
"error": "Invalid estimate state",
"symbolic": {
"id": "state"
}
}
Deletes an estimate
Example: deletes estimate by given id
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087563985487344.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: creates a note
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"note":{"note":"A pending TODO","assignee_id":416087565350733357,"todo":true}}' \
https://moneybird.com/api/v2/123/estimates/416087565233292840/notes.json
Response
Status: 201 Created
{
"id": "416087565410502191",
"administration_id": 123,
"entity_id": "416087565233292840",
"entity_type": "Estimate",
"user_id": 17110319469471,
"assignee_id": "416087565350733357",
"todo": true,
"note": "A pending TODO",
"completed_at": null,
"completed_by_id": null,
"todo_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:46.224Z",
"updated_at": "2024-03-21T14:40:46.224Z"
}
Destroys note from entity
Example: deletes a note
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087565525845560/notes/416087565636994621.json
Response
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL
where the attachment can be downloaded. Use the Location header in the response
to download the attachment.
Delete an attachment
Deletes an attachment of an attachable.
Sends an estimate
You can provide a send method, email address and message. If you don’t provide any arguments, the defaults from the contact and workflow will be used.
Parameters
| Parameter | Type | Description |
|---|---|---|
estimate_sending[delivery_method] |
String |
Can be |
estimate_sending[email_address] |
String |
|
estimate_sending[email_message] |
String |
|
estimate_sending[sign_online] |
Boolean |
|
sender |
Boolean |
|
signature_output |
String |
|
audit_trail |
String |
|
ip_address |
String |
Example: sends an estimate by given id
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087562435691951/send_estimate.json
Response
Status: 200 OK
{
"id": "416087562435691951",
"administration_id": 123,
"contact_id": "416087562381165996",
"contact": {
"id": "416087562381165996",
"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": "",
"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-03-21T14:40:43.339Z",
"updated_at": "2024-03-21T14:40:43.339Z",
"version": 1711032043,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c49bcf53125beb73648b0b863d78ae5fc441bfa3a69ffbf3f5a6d55235d3d570/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:43.391Z",
"updated_at": "2024-03-21T14:40:43.523Z",
"public_view_code": "700799",
"public_view_code_expires_at": "2024-06-21T13:40:43.482Z",
"version": 1711032043,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087562437789104",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:43.393Z",
"updated_at": "2024-03-21T14:40:43.520Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/a62888a02030ff41adb27b2114179028e8ccf0d56e0f02edd1f5ab7cf4d6db38/c49bcf53125beb73648b0b863d78ae5fc441bfa3a69ffbf3f5a6d55235d3d570",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:43.399Z",
"updated_at": "2024-03-21T14:40:43.399Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:43.534Z",
"updated_at": "2024-03-21T14:40:43.534Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: sends an estimate with alternative information
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"estimate_sending":{"delivery_method":"Email","email_address":"alternative@example.com","email_message":"Hi, this is an estimate with id {invoice_id}!"}}' \
https://moneybird.com/api/v2/123/estimates/416087562710418873/send_estimate.json
Response
Status: 200 OK
{
"id": "416087562710418873",
"administration_id": 123,
"contact_id": "416087562656941494",
"contact": {
"id": "416087562656941494",
"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": "",
"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-03-21T14:40:43.602Z",
"updated_at": "2024-03-21T14:40:43.602Z",
"version": 1711032043,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/409aa78fe36b9f153068a7649a29eff834d3aa9cf9cc3466f9a03bf3116c9c7a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:43.653Z",
"updated_at": "2024-03-21T14:40:43.759Z",
"public_view_code": "278646",
"public_view_code_expires_at": "2024-06-21T13:40:43.724Z",
"version": 1711032043,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087562712516026",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:43.655Z",
"updated_at": "2024-03-21T14:40:43.758Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/dac5dcce0f7457b5bf9d1025a8d3032ff7c8cedb89abd542bb4db7a659cd0685/409aa78fe36b9f153068a7649a29eff834d3aa9cf9cc3466f9a03bf3116c9c7a",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:43.661Z",
"updated_at": "2024-03-21T14:40:43.661Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "alternative@example.com",
"email_message": "Hi, this is an estimate with id {invoice_id}!"
},
"created_at": "2024-03-21T14:40:43.767Z",
"updated_at": "2024-03-21T14:40:43.767Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: returns error when sending estimate from identity without email
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087562976757187/send_estimate.json
Response
Status: 422 Unprocessable Entity
{
"error": {
"delivery_method": [
"The sender address must contain an email address"
]
}
}
Example: returns error when sending estimate to contact without email address
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087563163403724/send_estimate.json
Response
Status: 422 Unprocessable Entity
{
"error": {
"email_address": [
"can't be blank"
]
}
}
Example: returns error when sending invalid estimate without details
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087563364730325/send_estimate.json
Response
Status: 400 Bad Request
{
"error": "details cannot be empty",
"symbolic": {
"estimate": "details_cannot_be_empty"
}
}
Example: returns an error if delivery method Simplerinvoicing is given
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"estimate_sending":{"delivery_method":"Simplerinvoicing","email_address":"alternative@example.com"}}' \
https://moneybird.com/api/v2/123/estimates/416087563544036829/send_estimate.json
Response
Status: 400 Bad Request
{
"error": "Delivery Method isn't an option",
"symbolic": {
"estimate_sending": {
"delivery_method": "in"
}
}
}
Example: sends via Email if contact has delivery_method Simplerinvoicing
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/estimates/416087563708663269/send_estimate.json
Response
Status: 200 OK
{
"id": "416087563708663269",
"administration_id": 123,
"contact_id": "416087563655185890",
"contact": {
"id": "416087563655185890",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Simplerinvoicing",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"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": "12345678",
"si_identifier_type": "NL:KVK",
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:40:44.554Z",
"updated_at": "2024-03-21T14:40:44.632Z",
"version": 1711032044,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3f709de11419f339845cb26a0510da9d97a92fff28b3bdd2a08770488f9eac56/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"estimate_id": "2024-0001",
"workflow_id": "416087461498718092",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"estimate_date": "2024-03-21",
"due_date": "2024-04-04",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"exchange_rate": "1.0",
"discount": "0.0",
"original_estimate_id": null,
"show_tax": true,
"sign_online": true,
"sent_at": "2024-03-21",
"accepted_at": null,
"rejected_at": null,
"archived_at": null,
"created_at": "2024-03-21T14:40:44.605Z",
"updated_at": "2024-03-21T14:40:44.732Z",
"public_view_code": "542252",
"public_view_code_expires_at": "2024-06-21T13:40:44.694Z",
"version": 1711032044,
"pre_text": "Hello, here is your quote",
"post_text": "Please sign it",
"details": [
{
"id": "416087563710760422",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:40:44.607Z",
"updated_at": "2024-03-21T14:40:44.730Z",
"is_optional": false,
"is_selected": true
}
],
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"url": "http://moneybird.dev/123/estimates/ad5aa43a1b15eab28bbc84182c1d65c1c03350ef890bd96ebd1d49f74ed59d14/3f709de11419f339845cb26a0510da9d97a92fff28b3bdd2a08770488f9eac56",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:40:44.614Z",
"updated_at": "2024-03-21T14:40:44.614Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "estimate_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nHierbij ontvangt u van ons een prijsopgave 2024-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:40:44.745Z",
"updated_at": "2024-03-21T14:40:44.745Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Add attachment to estimate
Example: uploads an attachment
Request
curl -s -H "Content-Type: multipart/mixed" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-F file=@/tmp/upload.pdf \
https://moneybird.com/api/v2/123/estimates/416087565829932615/attachments.json
Response
Status: 200 OK
200