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": "204882851571697658",
    "administration_id": 123,
    "contact_id": "204882850432944106",
    "contact": {
      "id": "204882850432944106",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:14.048Z",
      "updated_at": "2017-11-02T08:32:14.048Z",
      "version": 1509611534,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/7d12806ff4a45d0ac5c2c771eb01894b3398bf3ce6294fa813262fc2420b45de/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0004",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:15.135Z",
    "updated_at": "2017-11-02T08:32:15.317Z",
    "version": 1509611535,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882851574843387",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:15.139Z",
        "updated_at": "2017-11-02T08:32:15.314Z"
      }
    ],
    "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/e6efdaed44d91497070dc6049a544ba4d0429d29958d43b98349811e7b6375b8/7d12806ff4a45d0ac5c2c771eb01894b3398bf3ce6294fa813262fc2420b45de",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:15.151Z",
        "updated_at": "2017-11-02T08:32:15.151Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:15.353Z",
        "updated_at": "2017-11-02T08:32:15.353Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "taxable_amount": "300.0",
        "taxable_amount_base": "300.0",
        "tax_amount": "63.0",
        "tax_amount_base": "63.0"
      }
    ]
  },
  {
    "id": "204882851229861878",
    "administration_id": 123,
    "contact_id": "204882850432944106",
    "contact": {
      "id": "204882850432944106",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:14.048Z",
      "updated_at": "2017-11-02T08:32:14.048Z",
      "version": 1509611534,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/7d12806ff4a45d0ac5c2c771eb01894b3398bf3ce6294fa813262fc2420b45de/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0003",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:14.809Z",
    "updated_at": "2017-11-02T08:32:15.009Z",
    "version": 1509611535,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882851234056183",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:14.813Z",
        "updated_at": "2017-11-02T08:32:15.005Z"
      }
    ],
    "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/2512d1b174aeff7978015118ab65613ee240840026e782e500adce1c517debfd/7d12806ff4a45d0ac5c2c771eb01894b3398bf3ce6294fa813262fc2420b45de",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:14.826Z",
        "updated_at": "2017-11-02T08:32:14.826Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:15.031Z",
        "updated_at": "2017-11-02T08:32:15.031Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "taxable_amount": "300.0",
        "taxable_amount_base": "300.0",
        "tax_amount": "63.0",
        "tax_amount_base": "63.0"
      }
    ]
  },
  {
    "id": "204882850895366130",
    "administration_id": 123,
    "contact_id": "204882850432944106",
    "contact": {
      "id": "204882850432944106",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:14.048Z",
      "updated_at": "2017-11-02T08:32:14.048Z",
      "version": 1509611534,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/7d12806ff4a45d0ac5c2c771eb01894b3398bf3ce6294fa813262fc2420b45de/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0002",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:14.490Z",
    "updated_at": "2017-11-02T08:32:14.678Z",
    "version": 1509611534,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882850899560435",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:14.494Z",
        "updated_at": "2017-11-02T08:32:14.674Z"
      }
    ],
    "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/95936294e3cd77bc895747bee2f1756d312b464accc05c98bd889f3720a108af/7d12806ff4a45d0ac5c2c771eb01894b3398bf3ce6294fa813262fc2420b45de",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:14.508Z",
        "updated_at": "2017-11-02T08:32:14.508Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:14.700Z",
        "updated_at": "2017-11-02T08:32:14.700Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "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": "204882853338547219",
    "administration_id": 123,
    "contact_id": "204882852156802051",
    "contact": {
      "id": "204882852156802051",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:15.692Z",
      "updated_at": "2017-11-02T08:32:15.692Z",
      "version": 1509611535,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/33edc3a09ffe9b9497d04cf1806a33a51c8add75d32c9a1d37baaf77436d7306/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0004",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:16.820Z",
    "updated_at": "2017-11-02T08:32:17.001Z",
    "version": 1509611537,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882853342741524",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:16.825Z",
        "updated_at": "2017-11-02T08:32:16.998Z"
      }
    ],
    "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/e88aceeedf94f7477a47eaad3cdbe7a751d8281028b32d23d1e4dbdf2e219143/33edc3a09ffe9b9497d04cf1806a33a51c8add75d32c9a1d37baaf77436d7306",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:16.837Z",
        "updated_at": "2017-11-02T08:32:16.837Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:17.024Z",
        "updated_at": "2017-11-02T08:32:17.024Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "taxable_amount": "300.0",
        "taxable_amount_base": "300.0",
        "tax_amount": "63.0",
        "tax_amount_base": "63.0"
      }
    ]
  },
  {
    "id": "204882853005100047",
    "administration_id": 123,
    "contact_id": "204882852156802051",
    "contact": {
      "id": "204882852156802051",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:15.692Z",
      "updated_at": "2017-11-02T08:32:15.692Z",
      "version": 1509611535,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/33edc3a09ffe9b9497d04cf1806a33a51c8add75d32c9a1d37baaf77436d7306/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0003",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:16.502Z",
    "updated_at": "2017-11-02T08:32:16.691Z",
    "version": 1509611536,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882853009294352",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:16.507Z",
        "updated_at": "2017-11-02T08:32:16.686Z"
      }
    ],
    "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/d171ebd42e6a125047e99b88208d3688ec638cb6d6f42820d69d3dedcd8d4fd9/33edc3a09ffe9b9497d04cf1806a33a51c8add75d32c9a1d37baaf77436d7306",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:16.520Z",
        "updated_at": "2017-11-02T08:32:16.520Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:16.712Z",
        "updated_at": "2017-11-02T08:32:16.712Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "taxable_amount": "300.0",
        "taxable_amount_base": "300.0",
        "tax_amount": "63.0",
        "tax_amount_base": "63.0"
      }
    ]
  },
  {
    "id": "204882852662215691",
    "administration_id": 123,
    "contact_id": "204882852156802051",
    "contact": {
      "id": "204882852156802051",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:15.692Z",
      "updated_at": "2017-11-02T08:32:15.692Z",
      "version": 1509611535,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/33edc3a09ffe9b9497d04cf1806a33a51c8add75d32c9a1d37baaf77436d7306/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0002",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:16.175Z",
    "updated_at": "2017-11-02T08:32:16.374Z",
    "version": 1509611536,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882852667458572",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:16.181Z",
        "updated_at": "2017-11-02T08:32:16.370Z"
      }
    ],
    "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/8b0f85736df8b124cf784e1c8234ea65e5d820cb261ff8463d9c1d1c0df4e01f/33edc3a09ffe9b9497d04cf1806a33a51c8add75d32c9a1d37baaf77436d7306",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:16.193Z",
        "updated_at": "2017-11-02T08:32:16.193Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:16.394Z",
        "updated_at": "2017-11-02T08:32:16.394Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "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": "204882855049823276",
    "administration_id": 123,
    "contact_id": "204882853891146780",
    "contact": {
      "id": "204882853891146780",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:17.347Z",
      "updated_at": "2017-11-02T08:32:17.347Z",
      "version": 1509611537,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/abeb9023b548e901b58f0913ebb4c61cb0ebf1c0e6948061e690670432c7029d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0004",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:18.453Z",
    "updated_at": "2017-11-02T08:32:18.657Z",
    "version": 1509611538,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882855055066157",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:18.457Z",
        "updated_at": "2017-11-02T08:32:18.653Z"
      }
    ],
    "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/f4ba4ce8a7c06ac6608eb030146e013fab64ba1c9ba69f7eb7749a8ac0e3f8d5/abeb9023b548e901b58f0913ebb4c61cb0ebf1c0e6948061e690670432c7029d",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:18.469Z",
        "updated_at": "2017-11-02T08:32:18.469Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:18.677Z",
        "updated_at": "2017-11-02T08:32:18.677Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "taxable_amount": "300.0",
        "taxable_amount_base": "300.0",
        "tax_amount": "63.0",
        "tax_amount_base": "63.0"
      }
    ]
  },
  {
    "id": "204882854738396200",
    "administration_id": 123,
    "contact_id": "204882853891146780",
    "contact": {
      "id": "204882853891146780",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:17.347Z",
      "updated_at": "2017-11-02T08:32:17.347Z",
      "version": 1509611537,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/abeb9023b548e901b58f0913ebb4c61cb0ebf1c0e6948061e690670432c7029d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0003",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:18.155Z",
    "updated_at": "2017-11-02T08:32:18.334Z",
    "version": 1509611538,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882854743639081",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:18.160Z",
        "updated_at": "2017-11-02T08:32:18.331Z"
      }
    ],
    "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/a495f618d1d5e9ff666976a6882bddda0bfc409585c25407db3ceb03b1a77984/abeb9023b548e901b58f0913ebb4c61cb0ebf1c0e6948061e690670432c7029d",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:18.176Z",
        "updated_at": "2017-11-02T08:32:18.176Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:18.354Z",
        "updated_at": "2017-11-02T08:32:18.354Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "taxable_amount": "300.0",
        "taxable_amount_base": "300.0",
        "tax_amount": "63.0",
        "tax_amount_base": "63.0"
      }
    ]
  },
  {
    "id": "204882854409143332",
    "administration_id": 123,
    "contact_id": "204882853891146780",
    "contact": {
      "id": "204882853891146780",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:17.347Z",
      "updated_at": "2017-11-02T08:32:17.347Z",
      "version": 1509611537,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/abeb9023b548e901b58f0913ebb4c61cb0ebf1c0e6948061e690670432c7029d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0002",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:17.841Z",
    "updated_at": "2017-11-02T08:32:18.029Z",
    "version": 1509611538,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882854412289061",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:17.845Z",
        "updated_at": "2017-11-02T08:32:18.026Z"
      }
    ],
    "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/d883b75922799495d7bba39ab3a6b59b67208e30d634b0535366128fff59f8ee/abeb9023b548e901b58f0913ebb4c61cb0ebf1c0e6948061e690670432c7029d",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:17.861Z",
        "updated_at": "2017-11-02T08:32:17.861Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:18.050Z",
        "updated_at": "2017-11-02T08:32:18.050Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "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": "204882856874345541",
    "administration_id": 123,
    "contact_id": "204882855645414453",
    "contact": {
      "id": "204882855645414453",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:19.020Z",
      "updated_at": "2017-11-02T08:32:19.020Z",
      "version": 1509611539,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/64dedc6f4c35c027d84398d0bde4f185b1463fc3c16cb9b8190916cb78c856b4/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0004",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:20.193Z",
    "updated_at": "2017-11-02T08:32:20.377Z",
    "version": 1509611540,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882856878539846",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:20.196Z",
        "updated_at": "2017-11-02T08:32:20.373Z"
      }
    ],
    "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/5acbb8168fe6079992e327d6a49df242f364d6ec3e60afb0873389c3403548df/64dedc6f4c35c027d84398d0bde4f185b1463fc3c16cb9b8190916cb78c856b4",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:20.211Z",
        "updated_at": "2017-11-02T08:32:20.211Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0004 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:20.396Z",
        "updated_at": "2017-11-02T08:32:20.396Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "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": "204882858255320154",
    "administration_id": 123,
    "contact_id": "204882857357739086",
    "contact": {
      "id": "204882857357739086",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:20.653Z",
      "updated_at": "2017-11-02T08:32:20.653Z",
      "version": 1509611540,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/d96527d72c13c1ccb5e85bf6822f8d057e780657e708c4d7ce2588f0f10ea967/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0003",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:21.509Z",
    "updated_at": "2017-11-02T08:32:21.698Z",
    "version": 1509611541,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882858258465883",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:21.513Z",
        "updated_at": "2017-11-02T08:32:21.694Z"
      }
    ],
    "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/7fbf70643f40c748fd0724959aee23d4f7e9e8c6eb066bec4aaa3341bb3d8e7c/d96527d72c13c1ccb5e85bf6822f8d057e780657e708c4d7ce2588f0f10ea967",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:21.525Z",
        "updated_at": "2017-11-02T08:32:21.525Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0003 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:21.719Z",
        "updated_at": "2017-11-02T08:32:21.719Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "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": "204882886976865667",
    "version": 1509611568
  },
  {
    "id": "204882886543803774",
    "version": 1509611568
  }
]
      

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": "204882887420413323",
    "version": 1509611569
  }
]
      

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":[204882888165950872,204882888609498525]}' \
  https://moneybird.com/api/v2/123/estimates/synchronization.json
    

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "204882888165950872",
    "administration_id": 123,
    "contact_id": "204882888004470165",
    "contact": {
      "id": "204882888004470165",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:49.879Z",
      "updated_at": "2017-11-02T08:32:49.879Z",
      "version": 1509611569,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/2b8e6a648a637233d5612137ff5f27c92c1ee8442fac59bb00ba38949738325d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": "2017-0001",
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": null,
    "state": "open",
    "estimate_date": "2017-11-02",
    "due_date": "2017-11-16",
    "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": "2017-11-02",
    "accepted_at": null,
    "rejected_at": null,
    "archived_at": null,
    "created_at": "2017-11-02T08:32:50.034Z",
    "updated_at": "2017-11-02T08:32:50.291Z",
    "version": 1509611570,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882888170145177",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:50.038Z",
        "updated_at": "2017-11-02T08:32:50.287Z"
      }
    ],
    "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/1f8061f09e43d413ce31b5c3286fedfe495ef93f693f0486c41b965f0813b7eb/2b8e6a648a637233d5612137ff5f27c92c1ee8442fac59bb00ba38949738325d",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:50.054Z",
        "updated_at": "2017-11-02T08:32:50.054Z"
      },
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "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 2017-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-11-02T08:32:50.320Z",
        "updated_at": "2017-11-02T08:32:50.320Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "taxable_amount": "300.0",
        "taxable_amount_base": "300.0",
        "tax_amount": "63.0",
        "tax_amount_base": "63.0"
      }
    ]
  },
  {
    "id": "204882888609498525",
    "administration_id": 123,
    "contact_id": "204882888004470165",
    "contact": {
      "id": "204882888004470165",
      "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": "FRST",
      "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,
      "created_at": "2017-11-02T08:32:49.879Z",
      "updated_at": "2017-11-02T08:32:49.879Z",
      "version": 1509611569,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/2b8e6a648a637233d5612137ff5f27c92c1ee8442fac59bb00ba38949738325d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "estimate_id": null,
    "workflow_id": "204882739586925686",
    "document_style_id": "204882739744212090",
    "identity_id": "204882738394694767",
    "draft_id": 2,
    "state": "draft",
    "estimate_date": null,
    "due_date": "2017-11-16",
    "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": "2017-11-02T08:32:50.457Z",
    "updated_at": "2017-11-02T08:32:50.472Z",
    "version": 1509611570,
    "pre_text": "Hello, here is your quote",
    "post_text": "Please sign it",
    "details": [
      {
        "id": "204882888619984286",
        "administration_id": 123,
        "tax_rate_id": "204882738248942697",
        "ledger_account_id": "204882737990992982",
        "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"
        ],
        "created_at": "2017-11-02T08:32:50.466Z",
        "updated_at": "2017-11-02T08:32:50.466Z"
      }
    ],
    "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/44694fb3e2f630177892c778500a02f89f632cd62dbd2b37e1658d09d191327f/2b8e6a648a637233d5612137ff5f27c92c1ee8442fac59bb00ba38949738325d",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1509611426969,
        "action": "estimate_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-11-02T08:32:50.488Z",
        "updated_at": "2017-11-02T08:32:50.488Z"
      }
    ],
    "tax_totals": [
      {
        "tax_rate_id": "204882738248942697",
        "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/204882861316113539.json?
    

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "204882861316113539",
  "administration_id": 123,
  "contact_id": "204882861101155456",
  "contact": {
    "id": "204882861101155456",
    "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": "FRST",
    "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,
    "created_at": "2017-11-02T08:32:24.223Z",
    "updated_at": "2017-11-02T08:32:24.223Z",
    "version": 1509611544,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/c3a4cb9705cc5537a023ac6b68311f96e8029772a19094594abaa05c255fea7b/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "estimate_id": "2017-0001",
  "workflow_id": "204882739586925686",
  "document_style_id": "204882739744212090",
  "identity_id": "204882738394694767",
  "draft_id": null,
  "state": "open",
  "estimate_date": "2017-11-02",
  "due_date": "2017-11-16",
  "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": "2017-11-02",
  "accepted_at": null,
  "rejected_at": null,
  "archived_at": null,
  "created_at": "2017-11-02T08:32:24.427Z",
  "updated_at": "2017-11-02T08:32:24.635Z",
  "version": 1509611544,
  "pre_text": "Hello, here is your quote",
  "post_text": "Please sign it",
  "details": [
    {
      "id": "204882861320307844",
      "administration_id": 123,
      "tax_rate_id": "204882738248942697",
      "ledger_account_id": "204882737990992982",
      "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"
      ],
      "created_at": "2017-11-02T08:32:24.433Z",
      "updated_at": "2017-11-02T08:32:24.632Z"
    }
  ],
  "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/1afb748ec5ccfed88bf2b0436e23a8ee276f253d0d432fb3c57a4405be865a6b/c3a4cb9705cc5537a023ac6b68311f96e8029772a19094594abaa05c255fea7b",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "estimate_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-11-02T08:32:24.450Z",
      "updated_at": "2017-11-02T08:32:24.450Z"
    },
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "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 2017-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
      },
      "created_at": "2017-11-02T08:32:24.659Z",
      "updated_at": "2017-11-02T08:32:24.659Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "204882738248942697",
      "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.

Creates a new estimate

Parameters

Parameter Type Description
estimate[contact_id] Integer

Should be a valid contact id.

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

Default workflow is used when value is not provided. 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 da, de, en, es, fr, it, no, nl, pt or tr.

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[details_attributes][*][id] Integer

Should be a valid detail id.

estimate[details_attributes][*][description] String
estimate[details_attributes][*][period] String

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.

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][*][product_id] Integer

Should be a valid product id.

estimate[details_attributes][*][row_order] Integer
estimate[details_attributes][*][_destroy] Boolean
estimate[custom_fields_attributes][*][id] Integer

Should be a valid custom field id.

estimate[custom_fields_attributes][*][value] String

Example: creates a new estimate

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"estimate":{"contact_id":204882863801238696,"reference":"Estimate Reference"}}' \
  https://moneybird.com/api/v2/123/estimates.json
    

Response

        
          
          Status: 201 Created
        
      
      {
  "id": "204882864496444592",
  "administration_id": 123,
  "contact_id": "204882863801238696",
  "contact": {
    "id": "204882863801238696",
    "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": "FRST",
    "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,
    "created_at": "2017-11-02T08:32:26.796Z",
    "updated_at": "2017-11-02T08:32:26.796Z",
    "version": 1509611546,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/c1e61ab9a99cde22512d26de140154bc5c0221e70b165655e5506d7fa134fa18/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "estimate_id": null,
  "workflow_id": "204882739586925686",
  "document_style_id": "204882739744212090",
  "identity_id": "204882738394694767",
  "draft_id": 2,
  "state": "draft",
  "estimate_date": null,
  "due_date": "2017-11-16",
  "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": "2017-11-02T08:32:27.461Z",
  "updated_at": "2017-11-02T08:32:27.461Z",
  "version": 1509611547,
  "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": [

  ],
  "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/a72237aff71c80a28513af2dbc61ad07e3887cfde44e415ca2b196d1aa8bbb03/c1e61ab9a99cde22512d26de140154bc5c0221e70b165655e5506d7fa134fa18",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "estimate_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-11-02T08:32:27.474Z",
      "updated_at": "2017-11-02T08:32:27.474Z"
    }
  ],
  "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[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

Default workflow is used when value is not provided. 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 da, de, en, es, fr, it, no, nl, pt or tr.

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[details_attributes][*][id] Integer

Should be a valid detail id.

estimate[details_attributes][*][description] String
estimate[details_attributes][*][period] String

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.

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][*][product_id] Integer

Should be a valid product id.

estimate[details_attributes][*][row_order] Integer
estimate[details_attributes][*][_destroy] Boolean
estimate[custom_fields_attributes][*][id] Integer

Should be a valid custom field id.

estimate[custom_fields_attributes][*][value] String

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/204882865081550007.json
    

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "204882865081550007",
  "administration_id": 123,
  "contact_id": "204882864716645556",
  "contact": {
    "id": "204882864716645556",
    "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": "FRST",
    "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,
    "created_at": "2017-11-02T08:32:27.670Z",
    "updated_at": "2017-11-02T08:32:27.670Z",
    "version": 1509611547,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/c3fcce8b9eba3732f4c5bd43d92b8d9c89d6be1d0077ee5d8de2745ceadca881/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "estimate_id": "2017-0001",
  "workflow_id": "204882739586925686",
  "document_style_id": "204882739744212090",
  "identity_id": "204882738394694767",
  "draft_id": null,
  "state": "open",
  "estimate_date": "2017-11-02",
  "due_date": "2017-11-16",
  "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": "2017-11-02",
  "accepted_at": null,
  "rejected_at": null,
  "archived_at": null,
  "created_at": "2017-11-02T08:32:28.018Z",
  "updated_at": "2017-11-02T08:32:28.432Z",
  "version": 1509611548,
  "pre_text": "Hello, here is your quote",
  "post_text": "Please sign it",
  "details": [
    {
      "id": "204882865087841464",
      "administration_id": 123,
      "tax_rate_id": "204882738248942697",
      "ledger_account_id": "204882737990992982",
      "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"
      ],
      "created_at": "2017-11-02T08:32:28.026Z",
      "updated_at": "2017-11-02T08:32:28.427Z"
    }
  ],
  "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/2c6f86b70e4246363ab9dff57f3d9e3c7f5f520dc44be401beed8f751d7db1bb/c3fcce8b9eba3732f4c5bd43d92b8d9c89d6be1d0077ee5d8de2745ceadca881",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "estimate_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-11-02T08:32:28.044Z",
      "updated_at": "2017-11-02T08:32:28.044Z"
    },
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "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 2017-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
      },
      "created_at": "2017-11-02T08:32:28.293Z",
      "updated_at": "2017-11-02T08:32:28.293Z"
    },
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "estimate_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "reference": [
          "Project X",
          "Updated Reference"
        ]
      },
      "created_at": "2017-11-02T08:32:28.439Z",
      "updated_at": "2017-11-02T08:32:28.439Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "204882738248942697",
      "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":204882738248942697,"ledger_account_id":204882737990992982},"1":{"id":204882866027365571,"_destroy":true}}}}' \
  https://moneybird.com/api/v2/123/estimates/204882866020025538.json
    

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "204882866020025538",
  "administration_id": 123,
  "contact_id": "204882865881613503",
  "contact": {
    "id": "204882865881613503",
    "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": "FRST",
    "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,
    "created_at": "2017-11-02T08:32:28.781Z",
    "updated_at": "2017-11-02T08:32:28.781Z",
    "version": 1509611548,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/522ce5fc521841dfd874ade7ae426fa404bfb61858a26c687b5a7368fced5d50/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "estimate_id": "2017-0001",
  "workflow_id": "204882739586925686",
  "document_style_id": "204882739744212090",
  "identity_id": "204882738394694767",
  "draft_id": null,
  "state": "open",
  "estimate_date": "2017-11-02",
  "due_date": "2017-11-16",
  "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": "2017-11-02",
  "accepted_at": null,
  "rejected_at": null,
  "archived_at": null,
  "created_at": "2017-11-02T08:32:28.914Z",
  "updated_at": "2017-11-02T08:32:29.389Z",
  "version": 1509611549,
  "pre_text": "Hello, here is your quote",
  "post_text": "Please sign it",
  "details": [
    {
      "id": "204882866513904839",
      "administration_id": 123,
      "tax_rate_id": "204882738248942697",
      "ledger_account_id": "204882737990992982",
      "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"
      ],
      "created_at": "2017-11-02T08:32:29.386Z",
      "updated_at": "2017-11-02T08:32:29.386Z"
    }
  ],
  "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/b089a9535e6d92f0de81d6fddf07a1846fe80d0af5cba3530c5f9674e7ef92f5/522ce5fc521841dfd874ade7ae426fa404bfb61858a26c687b5a7368fced5d50",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "estimate_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-11-02T08:32:28.954Z",
      "updated_at": "2017-11-02T08:32:28.954Z"
    },
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "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 2017-0001 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
      },
      "created_at": "2017-11-02T08:32:29.185Z",
      "updated_at": "2017-11-02T08:32:29.185Z"
    },
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "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": "204882738248942697",
              "report_reference": "NL/1a",
              "payable": true,
              "debit": 0,
              "credit": "63.0"
            }
          ],
          [
            {
              "tax_rate_id": "204882738248942697",
              "report_reference": "NL/1a",
              "payable": true,
              "debit": 0,
              "credit": "20.79"
            }
          ]
        ]
      },
      "created_at": "2017-11-02T08:32:29.392Z",
      "updated_at": "2017-11-02T08:32:29.392Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "204882738248942697",
      "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/204882867957794013/change_state.json
    

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "204882867957794013",
  "administration_id": 123,
  "contact_id": "204882867268879573",
  "contact": {
    "id": "204882867268879573",
    "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": "FRST",
    "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,
    "created_at": "2017-11-02T08:32:30.105Z",
    "updated_at": "2017-11-02T08:32:30.105Z",
    "version": 1509611550,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/8ee360029fc55e359d6a079870313255bdd87288880726453d792f0ec2214ab1/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "estimate_id": "2017-0002",
  "workflow_id": "204882739586925686",
  "document_style_id": "204882739744212090",
  "identity_id": "204882738394694767",
  "draft_id": null,
  "state": "accepted",
  "estimate_date": "2017-11-02",
  "due_date": "2017-11-16",
  "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": "2017-11-02",
  "accepted_at": "2017-11-02",
  "rejected_at": null,
  "archived_at": null,
  "created_at": "2017-11-02T08:32:30.761Z",
  "updated_at": "2017-11-02T08:32:31.088Z",
  "version": 1509611551,
  "pre_text": "Hello, here is your quote",
  "post_text": "Please sign it",
  "details": [
    {
      "id": "204882867966182622",
      "administration_id": 123,
      "tax_rate_id": "204882738248942697",
      "ledger_account_id": "204882737990992982",
      "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"
      ],
      "created_at": "2017-11-02T08:32:30.769Z",
      "updated_at": "2017-11-02T08:32:30.973Z"
    }
  ],
  "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/e5d1499a590f11a48c2fa3d27d98e90f5d997563bdae8944874a3ace0ba689b0/8ee360029fc55e359d6a079870313255bdd87288880726453d792f0ec2214ab1",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "estimate_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-11-02T08:32:30.787Z",
      "updated_at": "2017-11-02T08:32:30.787Z"
    },
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "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 2017-0002 voor onze\ndiensten.\n\nMet vriendelijke groet,\n\nParkietje B.V."
      },
      "created_at": "2017-11-02T08:32:30.995Z",
      "updated_at": "2017-11-02T08:32:30.995Z"
    },
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "estimate_mark_accepted",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-11-02T08:32:31.097Z",
      "updated_at": "2017-11-02T08:32:31.097Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "204882738248942697",
      "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/204882870673605884/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/204882873188091159/bill_estimate.json
    

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "204882873986057501",
  "administration_id": 123,
  "contact_id": "204882872543216911",
  "contact": {
    "id": "204882872543216911",
    "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": "FRST",
    "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,
    "created_at": "2017-11-02T08:32:35.134Z",
    "updated_at": "2017-11-02T08:32:35.134Z",
    "version": 1509611555,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/2e4be8360a6accf93190b881dd40107b7d939db10b9776c9614b4321e8d37163/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "invoice_id": null,
  "recurring_sales_invoice_id": null,
  "workflow_id": "204882739091997808",
  "document_style_id": "204882739744212090",
  "identity_id": "204882738394694767",
  "draft_id": 1,
  "state": "draft",
  "invoice_date": null,
  "due_date": "2017-11-16",
  "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 het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Project X",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": null,
  "paid_at": null,
  "sent_at": null,
  "created_at": "2017-11-02T08:32:36.505Z",
  "updated_at": "2017-11-02T08:32:36.528Z",
  "version": 1509611556,
  "details": [
    {
      "id": "204882873995494686",
      "administration_id": 123,
      "tax_rate_id": "204882738248942697",
      "ledger_account_id": "204882737990992982",
      "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"
      ],
      "created_at": "2017-11-02T08:32:36.518Z",
      "updated_at": "2017-11-02T08:32:36.518Z"
    }
  ],
  "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",
  "url": "http://moneybird.dev/123/sales_invoices/d758e0735da1e2d9b49e163b0606d827d9f1681716cea4aca17e29259c26300b/2e4be8360a6accf93190b881dd40107b7d939db10b9776c9614b4321e8d37163",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1509611426969,
      "action": "sales_invoice_created_based_on_estimate",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "original_estimate": "2017-0002"
      },
      "created_at": "2017-11-02T08:32:36.549Z",
      "updated_at": "2017-11-02T08:32:36.549Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "204882738248942697",
      "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/204882877436921131/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/204882885773100405.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 true the note is a to-do.

note[assignee_id] Integer

Assign to-do to user. Should be a valid user id.

Destroys note from entity

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 Email, Post or Manual. Can be Email, Simplerinvoicing, Post or Manual.

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/204882879630542132/send_estimate.json
    

Response

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/204882881012565310/send_estimate.json
    

Response

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/204882882078967112/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/204882883100280145/send_estimate.json
    

Response

        
          
          Status: 422 Unprocessable Entity
        
      
      {
  "error": {
    "email_address": [
      "cannot be empty"
    ]
  }
}
      

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/204882884207576410/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/204882884810507618/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/204882885193237866/send_estimate.json
    

Response

Add attachment to estimate