External sales invoices

List all external invoices

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

The filter argument allows you to filter the list of external invoices. 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, new, open, late, or paid
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   Select invoices belonging to a certain contact

You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:new|open.

Parameters

Parameter Type Description
filter String

Example: returns all external sales invoices of an administration

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "273147099358430869",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2019-11-25",
    "state": "new",
    "due_date": null,
    "reference": "Invoice 4",
    "entry_number": 104,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:14.961Z",
    "updated_at": "2019-11-25T20:23:14.961Z",
    "version": 1574713394,
    "details": [

    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  },
  {
    "id": "273147099331167891",
    "administration_id": 123,
    "contact_id": "273147099228407440",
    "contact": {
      "id": "273147099228407440",
      "administration_id": 123,
      "company_name": "Relation 3",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "596d4cb55dc8e203f435f89519f0f8eac05b5392fdb0da08211b74cddfcae872",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:14.838Z",
      "updated_at": "2019-11-25T20:23:14.838Z",
      "version": 1574713394,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/3b9828373744f6924b9c09bf48adaaf5efff4daba7514a2b3ec2991b95920f69/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 3",
    "entry_number": 103,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:14.935Z",
    "updated_at": "2019-11-25T20:23:14.945Z",
    "version": 1574713394,
    "details": [
      {
        "id": "273147099337459348",
        "administration_id": 123,
        "tax_rate_id": "273147099301807762",
        "ledger_account_id": "273147099293419153",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:14.941Z",
        "updated_at": "2019-11-25T20:23:14.941Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147099301807762",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "273147099200095885",
    "administration_id": 123,
    "contact_id": "273147099143472778",
    "contact": {
      "id": "273147099143472778",
      "administration_id": 123,
      "company_name": "Relation 2",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "f0afdb5920e7734a9568a755efd47d9da55780e48e94ef16c7c41614710411cc",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:14.757Z",
      "updated_at": "2019-11-25T20:23:14.757Z",
      "version": 1574713394,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/772b15abb92db56dbd32eaae9bb8056bf3eb03ba1384bbf1a83121ac2927963b/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 2",
    "entry_number": 102,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:14.807Z",
    "updated_at": "2019-11-25T20:23:14.818Z",
    "version": 1574713394,
    "details": [
      {
        "id": "273147099203241614",
        "administration_id": 123,
        "tax_rate_id": "273147099164444300",
        "ledger_account_id": "273147099157104267",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:14.814Z",
        "updated_at": "2019-11-25T20:23:14.814Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147099164444300",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]
      

Example: returns all invoices filtered on period

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "273147099946682024",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2019-11-25",
    "state": "new",
    "due_date": null,
    "reference": "Invoice 8",
    "entry_number": 108,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:15.521Z",
    "updated_at": "2019-11-25T20:23:15.521Z",
    "version": 1574713395,
    "details": [

    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  },
  {
    "id": "273147099908933286",
    "administration_id": 123,
    "contact_id": "273147099861747363",
    "contact": {
      "id": "273147099861747363",
      "administration_id": 123,
      "company_name": "Relation 6",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "440cbd12fc10a7eb09afc0ba2142b53f72ae838a1ee52d0fceae9b305d08fae7",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:15.441Z",
      "updated_at": "2019-11-25T20:23:15.441Z",
      "version": 1574713395,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/925ced7d9626e9f853eb63f1e38601c63767256b4a7e250fdb84ff109c539e24/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 7",
    "entry_number": 107,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:15.486Z",
    "updated_at": "2019-11-25T20:23:15.501Z",
    "version": 1574713395,
    "details": [
      {
        "id": "273147099919419047",
        "administration_id": 123,
        "tax_rate_id": "273147099882718885",
        "ledger_account_id": "273147099876427428",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:15.497Z",
        "updated_at": "2019-11-25T20:23:15.497Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147099882718885",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "273147099790444192",
    "administration_id": 123,
    "contact_id": "273147099726481053",
    "contact": {
      "id": "273147099726481053",
      "administration_id": 123,
      "company_name": "Relation 5",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "374b21dd901c0d2b959f74ca216a386208ebaf1dc6480b509209b6fae43a2634",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:15.290Z",
      "updated_at": "2019-11-25T20:23:15.290Z",
      "version": 1574713395,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/c034a2d5a52abf819453080ad3e266ad3414fcba1d9607bb4ba1d61318588ca3/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 6",
    "entry_number": 106,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:15.374Z",
    "updated_at": "2019-11-25T20:23:15.415Z",
    "version": 1574713395,
    "details": [
      {
        "id": "273147099794638497",
        "administration_id": 123,
        "tax_rate_id": "273147099764229791",
        "ledger_account_id": "273147099757938334",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:15.377Z",
        "updated_at": "2019-11-25T20:23:15.377Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147099764229791",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]
      

Example: returns all invoices filtered on state

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "273147100387083961",
    "administration_id": 123,
    "contact_id": "273147100341995190",
    "contact": {
      "id": "273147100341995190",
      "administration_id": 123,
      "company_name": "Relation 9",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "91eb6c24a62061f39a598104e5d6558494d3022f8de1bc892f8ac448c25bf5d1",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:15.899Z",
      "updated_at": "2019-11-25T20:23:15.899Z",
      "version": 1574713395,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/2ce596aab4c6de27243532baffbd73be8b87c70072d4570bdbc205b347babb6d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 11",
    "entry_number": 111,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:15.942Z",
    "updated_at": "2019-11-25T20:23:15.949Z",
    "version": 1574713395,
    "details": [
      {
        "id": "273147100391278266",
        "administration_id": 123,
        "tax_rate_id": "273147100361918136",
        "ledger_account_id": "273147100353529527",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:15.945Z",
        "updated_at": "2019-11-25T20:23:15.945Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147100361918136",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "273147100324169395",
    "administration_id": 123,
    "contact_id": "273147100280129200",
    "contact": {
      "id": "273147100280129200",
      "administration_id": 123,
      "company_name": "Relation 8",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "9a4e1ad62ed5f7405810590a0b841f21cfee4a7868cd6b27b9aa1b7804f93326",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:15.840Z",
      "updated_at": "2019-11-25T20:23:15.840Z",
      "version": 1574713395,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/6e92692a27b3f0cd3ed9ca36499c33c980db9905cf23bbc22652b5fbbe5d7e36/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 10",
    "entry_number": 110,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:15.882Z",
    "updated_at": "2019-11-25T20:23:15.889Z",
    "version": 1574713395,
    "details": [
      {
        "id": "273147100328363700",
        "administration_id": 123,
        "tax_rate_id": "273147100299003570",
        "ledger_account_id": "273147100291663537",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:15.885Z",
        "updated_at": "2019-11-25T20:23:15.885Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147100299003570",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "273147100252866221",
    "administration_id": 123,
    "contact_id": "273147100199388842",
    "contact": {
      "id": "273147100199388842",
      "administration_id": 123,
      "company_name": "Relation 7",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "d1132213b48d482bc20739138a7e63b32e6137fd5dd28afaba2351a752ea707c",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:15.763Z",
      "updated_at": "2019-11-25T20:23:15.763Z",
      "version": 1574713395,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/16519072b11fd047c2ecfa236108edc150b9b435d4222a28fe643fb673a329bc/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 9",
    "entry_number": 109,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:15.813Z",
    "updated_at": "2019-11-25T20:23:15.822Z",
    "version": 1574713395,
    "details": [
      {
        "id": "273147100257060526",
        "administration_id": 123,
        "tax_rate_id": "273147100217214636",
        "ledger_account_id": "273147100210923179",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:15.817Z",
        "updated_at": "2019-11-25T20:23:15.817Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147100217214636",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]
      

Example: returns paginated external sales invoices on page 1

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "273147101019375310",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2019-11-25",
    "state": "new",
    "due_date": null,
    "reference": "Invoice 16",
    "entry_number": 116,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:16.545Z",
    "updated_at": "2019-11-25T20:23:16.545Z",
    "version": 1574713396,
    "details": [

    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  }
]
      

Example: returns paginated external sales invoices on page 2

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "273147101287810783",
    "administration_id": 123,
    "contact_id": "273147101244819164",
    "contact": {
      "id": "273147101244819164",
      "administration_id": 123,
      "company_name": "Relation 15",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "9eb195e41d1c7db6160312276b343df4b39a95c854869b4e2636fdf6675c20a3",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "created_at": "2019-11-25T20:23:16.759Z",
      "updated_at": "2019-11-25T20:23:16.759Z",
      "version": 1574713396,
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/abc34873ccb1ad5531064449d52bd0e1b5ade6895a6dacb55c07f59d189e754f/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "date": "2019-11-25",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 19",
    "entry_number": 119,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2019-11-25T20:23:16.799Z",
    "updated_at": "2019-11-25T20:23:16.812Z",
    "version": 1574713396,
    "details": [
      {
        "id": "273147101295150816",
        "administration_id": 123,
        "tax_rate_id": "273147101262644958",
        "ledger_account_id": "273147101256353501",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "created_at": "2019-11-25T20:23:16.803Z",
        "updated_at": "2019-11-25T20:23:16.803Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "0.0",
    "total_unpaid_base": "0.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "0.0",
    "total_price_excl_tax_base": "0.0",
    "total_price_incl_tax": "0.0",
    "total_price_incl_tax_base": "0.0",
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "273147101262644958",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]
      

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

Request

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

Response

        
          
          Status: 400 Bad Request
        
      
      {
  "error": "Per Page is too big",
  "symbolic": {
    "per_page": "max"
  }
}
      

Example: returns an error message if filter contact_id is not found

Request

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

Response

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

Get an external sales invoice by id

Returns an external sales invoices in the administration.

Example: returns invoice by given id

Request

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

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "273147102117234444",
  "administration_id": 123,
  "contact_id": "273147102026008329",
  "contact": {
    "id": "273147102026008329",
    "administration_id": 123,
    "company_name": "Relation 22",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "07004262ae2d054bb8b5931124ffa79344460e7ca427af0d19d8c743a77241ad",
    "tax_number": null,
    "chamber_of_commerce": null,
    "bank_account": null,
    "attention": null,
    "email": null,
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": null,
    "send_estimates_to_attention": null,
    "send_estimates_to_email": null,
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "created_at": "2019-11-25T20:23:17.502Z",
    "updated_at": "2019-11-25T20:23:17.502Z",
    "version": 1574713397,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/e5d05549e8f2f2c5cf098dc9387ddab0a2054cdafea9e474bf14188f64a67539/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "date": "2019-11-25",
  "state": "open",
  "due_date": null,
  "reference": "Invoice 29",
  "entry_number": 129,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2019-11-25T20:23:17.590Z",
  "updated_at": "2019-11-25T20:23:17.597Z",
  "version": 1574713397,
  "details": [
    {
      "id": "273147102120380173",
      "administration_id": 123,
      "tax_rate_id": "273147102042785547",
      "ledger_account_id": "273147102036494090",
      "project_id": null,
      "product_id": null,
      "amount": "1 x",
      "amount_decimal": "1.0",
      "description": "Invoice detail description",
      "price": "100.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "100.0",
      "total_price_excl_tax_with_discount_base": "100.0",
      "tax_report_reference": [

      ],
      "created_at": "2019-11-25T20:23:17.593Z",
      "updated_at": "2019-11-25T20:23:17.593Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "0.0",
  "total_unpaid_base": "0.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "0.0",
  "total_price_excl_tax_base": "0.0",
  "total_price_incl_tax": "0.0",
  "total_price_incl_tax_base": "0.0",
  "notes": [

  ],
  "attachments": [

  ],
  "events": [

  ],
  "tax_totals": [
    {
      "tax_rate_id": "273147102042785547",
      "taxable_amount": "100.0",
      "taxable_amount_base": "100.0",
      "tax_amount": "21.0",
      "tax_amount_base": "21.0"
    }
  ]
}
      

Example: returns 404 when invoice does not exist

Request

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

Response

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

Create an external sales invoice

Parameters

Parameter Type Description
external_sales_invoice[contact_id] Integer

Should be a valid contact id.

external_sales_invoice[reference] String

Should be unique for the administration.

external_sales_invoice[date] String
external_sales_invoice[due_date] String
external_sales_invoice[currency] String

ISO three-character currency code, e.g. EUR or USD.

external_sales_invoice[prices_are_incl_tax] Boolean
external_sales_invoice[source] String
external_sales_invoice[source_url] String
external_sales_invoice[details_attributes][id] Integer
external_sales_invoice[details_attributes][description] String
external_sales_invoice[details_attributes][period] String

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

external_sales_invoice[details_attributes][price] Decimal

Both a decimal and a string ‘10,95’ are accepted.

external_sales_invoice[details_attributes][amount] String
external_sales_invoice[details_attributes][tax_rate_id] Integer

Should be a valid tax rate id.

external_sales_invoice[details_attributes][ledger_account_id] Integer

Should be a valid ledger account id.

external_sales_invoice[details_attributes][project_id] Integer

Should be a valid project id.

external_sales_invoice[details_attributes][row_order] Integer
external_sales_invoice[details_attributes][_destroy] Boolean
user_agent String

Example: create a basic external sales invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"external_sales_invoice":{"reference":"30052","contact_id":273147102502061852,"details_attributes":[{"description":"Rocking Chair","price":129.95}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices
    

Response

        
          
          Status: 201 Created
        
      
      {
  "id": "273147102607968031",
  "administration_id": 123,
  "contact_id": "273147102502061852",
  "contact": {
    "id": "273147102502061852",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "created_at": "2019-11-25T20:23:17.956Z",
    "updated_at": "2019-11-25T20:23:17.956Z",
    "version": 1574713397,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/9780482f2a5627818cb4ca2a1ed45fc6fb14134984e6ba9f26bd67bfaf274334/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "date": "2019-11-25",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2019-11-25T20:23:18.057Z",
  "updated_at": "2019-11-25T20:23:18.064Z",
  "version": 1574713398,
  "details": [
    {
      "id": "273147102611113760",
      "administration_id": 123,
      "tax_rate_id": "273146955111072881",
      "ledger_account_id": "273146954950640734",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": 1,
      "description": "Rocking Chair",
      "price": "129.95",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "129.95",
      "total_price_excl_tax_with_discount_base": "129.95",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2019-11-25T20:23:18.060Z",
      "updated_at": "2019-11-25T20:23:18.060Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "157.24",
  "total_unpaid_base": "157.24",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "129.95",
  "total_price_excl_tax_base": "129.95",
  "total_price_incl_tax": "157.24",
  "total_price_incl_tax_base": "157.24",
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 15747132565543,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2019-11-25T20:23:18.067Z",
      "updated_at": "2019-11-25T20:23:18.067Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "273146955111072881",
      "taxable_amount": "129.95",
      "taxable_amount_base": "129.95",
      "tax_amount": "27.29",
      "tax_amount_base": "27.29"
    }
  ]
}
      

Example: create an external sales invoice in a foreign currency

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"external_sales_invoice":{"reference":"30052","contact_id":273147103165810489,"currency":"USD","details_attributes":[{"description":"Rocking Chair","price":159.99,"tax_rate_id":273147103137498934}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices
    

Response

        
          
          Status: 201 Created
        
      
      {
  "id": "273147103259133756",
  "administration_id": 123,
  "contact_id": "273147103165810489",
  "contact": {
    "id": "273147103165810489",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "created_at": "2019-11-25T20:23:18.588Z",
    "updated_at": "2019-11-25T20:23:18.588Z",
    "version": 1574713398,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/160ca507ff7acbdb1bb452feb84203e9ec56e0a9d77fb4719cc0c662637af498/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "date": "2019-11-25",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "USD",
  "paid_at": null,
  "created_at": "2019-11-25T20:23:18.678Z",
  "updated_at": "2019-11-25T20:23:18.685Z",
  "version": 1574713398,
  "details": [
    {
      "id": "273147103263328061",
      "administration_id": 123,
      "tax_rate_id": "273147103137498934",
      "ledger_account_id": "273146954950640734",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": 1,
      "description": "Rocking Chair",
      "price": "159.99",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "159.99",
      "total_price_excl_tax_with_discount_base": "127.99",
      "tax_report_reference": [
        "NL/3b"
      ],
      "created_at": "2019-11-25T20:23:18.681Z",
      "updated_at": "2019-11-25T20:23:18.681Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "159.99",
  "total_unpaid_base": "127.99",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "159.99",
  "total_price_excl_tax_base": "127.99",
  "total_price_incl_tax": "159.99",
  "total_price_incl_tax_base": "127.99",
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 15747132565543,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2019-11-25T20:23:18.689Z",
      "updated_at": "2019-11-25T20:23:18.689Z"
    }
  ],
  "tax_totals": [

  ]
}
      

Create external sales invoice from attachment

Add attachment to external sales invoice

Update an external sales invoice

When updating an external sales invoice, provide only the attributes you want to update. The other attributes will not be changed.

Parameters

Parameter Type Description
external_sales_invoice[contact_id] Integer

Should be a valid contact id.

external_sales_invoice[reference] String

Should be unique for the administration.

external_sales_invoice[date] String
external_sales_invoice[due_date] String
external_sales_invoice[currency] String

ISO three-character currency code, e.g. EUR or USD.

external_sales_invoice[prices_are_incl_tax] Boolean
external_sales_invoice[source] String
external_sales_invoice[source_url] String
external_sales_invoice[details_attributes][id] Integer
external_sales_invoice[details_attributes][description] String
external_sales_invoice[details_attributes][period] String

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

external_sales_invoice[details_attributes][price] Decimal

Both a decimal and a string ‘10,95’ are accepted.

external_sales_invoice[details_attributes][amount] String
external_sales_invoice[details_attributes][tax_rate_id] Integer

Should be a valid tax rate id.

external_sales_invoice[details_attributes][ledger_account_id] Integer

Should be a valid ledger account id.

external_sales_invoice[details_attributes][project_id] Integer

Should be a valid project id.

external_sales_invoice[details_attributes][row_order] Integer
external_sales_invoice[details_attributes][_destroy] Boolean
user_agent String

Example: updating the invoice reference

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"external_sales_invoice":{"reference":"30053"}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/273147109022107490
    

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "273147109022107490",
  "administration_id": 123,
  "contact_id": "273147108964435807",
  "contact": {
    "id": "273147108964435807",
    "administration_id": 123,
    "company_name": "Relation 30",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "6c31d836884b00812273411efbbbf4601726b558c834bc59a4850994d8d407c3",
    "tax_number": null,
    "chamber_of_commerce": null,
    "bank_account": null,
    "attention": null,
    "email": null,
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": null,
    "send_estimates_to_attention": null,
    "send_estimates_to_email": null,
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "created_at": "2019-11-25T20:23:24.112Z",
    "updated_at": "2019-11-25T20:23:24.112Z",
    "version": 1574713404,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/90399c60b9420db930dc7b86b8f207db182b34a0d3e88873c244ec979e865f96/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "date": "2019-11-25",
  "state": "open",
  "due_date": null,
  "reference": "30053",
  "entry_number": 1,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2019-11-25T20:23:24.167Z",
  "updated_at": "2019-11-25T20:23:24.279Z",
  "version": 1574713404,
  "details": [
    {
      "id": "273147109028398947",
      "administration_id": 123,
      "tax_rate_id": "273147108990650209",
      "ledger_account_id": "273147108977018720",
      "project_id": null,
      "product_id": null,
      "amount": "1 x",
      "amount_decimal": "1.0",
      "description": "Invoice detail description",
      "price": "100.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "100.0",
      "total_price_excl_tax_with_discount_base": "100.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2019-11-25T20:23:24.171Z",
      "updated_at": "2019-11-25T20:23:24.275Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "121.0",
  "total_unpaid_base": "121.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "100.0",
  "total_price_excl_tax_base": "100.0",
  "total_price_incl_tax": "121.0",
  "total_price_incl_tax_base": "121.0",
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 15747132565543,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2019-11-25T20:23:24.282Z",
      "updated_at": "2019-11-25T20:23:24.282Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "273147108990650209",
      "taxable_amount": "100.0",
      "taxable_amount_base": "100.0",
      "tax_amount": "21.0",
      "tax_amount_base": "21.0"
    }
  ]
}
      

Example: adding and removing an invoice detail

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"external_sales_invoice":{"details_attributes":[{"description":"Sofa","price":199.99},{"id":273147109387011947,"_destroy":true}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/273147109383866218
    

Response

        
          
          Status: 200 OK
        
      
      {
  "id": "273147109383866218",
  "administration_id": 123,
  "contact_id": "273147109340874599",
  "contact": {
    "id": "273147109340874599",
    "administration_id": 123,
    "company_name": "Relation 31",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "869ec831adf6ea31c627ac184e6fb97468a7b2e0055a0695049a67c0a91f9738",
    "tax_number": null,
    "chamber_of_commerce": null,
    "bank_account": null,
    "attention": null,
    "email": null,
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": null,
    "send_estimates_to_attention": null,
    "send_estimates_to_email": null,
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "created_at": "2019-11-25T20:23:24.470Z",
    "updated_at": "2019-11-25T20:23:24.470Z",
    "version": 1574713404,
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/02b551d1732459c5a8f54c128368e48c3a4a6f766fef95b96bbdecf27e32ac42/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "date": "2019-11-25",
  "state": "open",
  "due_date": null,
  "reference": "Invoice 38",
  "entry_number": 1,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2019-11-25T20:23:24.512Z",
  "updated_at": "2019-11-25T20:23:24.682Z",
  "version": 1574713404,
  "details": [
    {
      "id": "273147109556881261",
      "administration_id": 123,
      "tax_rate_id": "273146955111072881",
      "ledger_account_id": "273146954950640734",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": 1,
      "description": "Sofa",
      "price": "199.99",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "199.99",
      "total_price_excl_tax_with_discount_base": "199.99",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2019-11-25T20:23:24.675Z",
      "updated_at": "2019-11-25T20:23:24.675Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "241.99",
  "total_unpaid_base": "241.99",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "199.99",
  "total_price_excl_tax_base": "199.99",
  "total_price_incl_tax": "241.99",
  "total_price_incl_tax_base": "241.99",
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 15747132565543,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2019-11-25T20:23:24.689Z",
      "updated_at": "2019-11-25T20:23:24.689Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "273146955111072881",
      "taxable_amount": "199.99",
      "taxable_amount_base": "199.99",
      "tax_amount": "42.0",
      "tax_amount_base": "42.0"
    }
  ]
}
      

Delete an external sales invoice

Example: deletes given invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/273147109895571315.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.

Example: create a note

Request

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

Response

        
          
          Status: 201 Created
        
      
      {
  "id": "273147110235309948",
  "administration_id": 123,
  "entity_id": "273147110157715322",
  "entity_type": "ExternalSalesInvoice",
  "user_id": 15747132565543,
  "assignee_id": 15747132565543,
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {
  },
  "created_at": "2019-11-25T20:23:25.323Z",
  "updated_at": "2019-11-25T20:23:25.323Z"
}
      

Destroys note from entity

Example: destroy a note

Request

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

Response

Create a payment

Parameters

Parameter Type Description
payment[payment_date] String

Required

payment[price] Decimal

Required

Both a decimal and a string ‘10,95’ are accepted. Should be a number -1,000,000,000 <= n <= 1,000,000,000.

payment[price_base] Decimal

Amount paid expressed in the base currency. Required for foreign currencies. Should be a number -1,000,000,000 <= n <= 1,000,000,000.

payment[financial_account_id] Integer

Should be a valid financial account id.

payment[financial_mutation_id] Integer

Should be a valid financial mutation id.

payment[transaction_identifier] String

Example: create a payment

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"payment":{"payment_date":"2019-11-25 20:23:25 UTC","price":"0.0"}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/273147110637963147/payments.json
    

Response

        
          
          Status: 201 Created
        
      
      {
  "id": "273147110733383565",
  "administration_id": 123,
  "invoice_type": "ExternalSalesInvoice",
  "invoice_id": "273147110637963147",
  "financial_account_id": null,
  "user_id": 15747132565543,
  "payment_transaction_id": null,
  "transaction_identifier": null,
  "price": "0.0",
  "price_base": "0.0",
  "payment_date": "2019-11-25",
  "credit_invoice_id": null,
  "financial_mutation_id": null,
  "created_at": "2019-11-25T20:23:25.790Z",
  "updated_at": "2019-11-25T20:23:25.790Z"
}
      

Delete a payment

Example: destroy a payment

Request

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

Response