External sales invoices

cURL Ruby

List all external invoices

GET /external_sales_invoices(.:format)

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": "416087568813131414",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.473Z",
    "updated_at": "2024-03-21T14:40:49.473Z",
    "version": 1711032049,
    "details": [

    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  },
  {
    "id": "416087568785868435",
    "administration_id": 123,
    "contact_id": "416087568726099600",
    "contact": {
      "id": "416087568726099600",
      "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": "053427ece42fc7b7a2a3b7b55369932788c869c878ed776a002e83279cc69b84",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:49.388Z",
      "updated_at": "2024-03-21T14:40:49.388Z",
      "version": 1711032049,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/960961d5b03ee700bdb779d6704b8f0252158665c64a8809b3bb233141133243/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.446Z",
    "updated_at": "2024-03-21T14:40:49.456Z",
    "version": 1711032049,
    "details": [
      {
        "id": "416087568790062740",
        "administration_id": 123,
        "tax_rate_id": "416087568748119698",
        "ledger_account_id": "416087568740779665",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:49.450Z",
        "updated_at": "2024-03-21T14:40:49.450Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087568748119698",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "416087568685205132",
    "administration_id": 123,
    "contact_id": "416087568609707657",
    "contact": {
      "id": "416087568609707657",
      "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": "051e45e74e4f2159701ec51736cd8639e4b533f632c843f25db20143bf22ca5e",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:49.279Z",
      "updated_at": "2024-03-21T14:40:49.279Z",
      "version": 1711032049,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/499839a8f61b05de102c971d2b74858cbebb71129a7841eb84f52b6e6f721f1d/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.349Z",
    "updated_at": "2024-03-21T14:40:49.360Z",
    "version": 1711032049,
    "details": [
      {
        "id": "416087568690448013",
        "administration_id": 123,
        "tax_rate_id": "416087568636970635",
        "ledger_account_id": "416087568622290570",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:49.354Z",
        "updated_at": "2024-03-21T14:40:49.354Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087568636970635",
        "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": "416087569129801389",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.776Z",
    "updated_at": "2024-03-21T14:40:49.776Z",
    "version": 1711032049,
    "details": [

    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  },
  {
    "id": "416087569118267050",
    "administration_id": 123,
    "contact_id": "416087569100441255",
    "contact": {
      "id": "416087569100441255",
      "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": "bfd1dc174570157469503efaf658e633cbca1f969160add6248dac360b704d3c",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:49.747Z",
      "updated_at": "2024-03-21T14:40:49.747Z",
      "version": 1711032049,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/580105a09dfcc25f08063d8ff7af1813f1afac45e2838625786ec57ffbed5de7/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.764Z",
    "updated_at": "2024-03-21T14:40:49.768Z",
    "version": 1711032049,
    "details": [
      {
        "id": "416087569119315627",
        "administration_id": 123,
        "tax_rate_id": "416087569108829865",
        "ledger_account_id": "416087569105684136",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:49.766Z",
        "updated_at": "2024-03-21T14:40:49.766Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087569108829865",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "416087569087858339",
    "administration_id": 123,
    "contact_id": "416087569070032544",
    "contact": {
      "id": "416087569070032544",
      "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": "c6612cae749b4c496f07c36d0c143bad2a7f93785c05a1f3ea239bb685e75a32",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:49.718Z",
      "updated_at": "2024-03-21T14:40:49.718Z",
      "version": 1711032049,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1d11f8c1647b21d7e6ee769316569ea60bb636f58ba28c4d56acdab4db07fee9/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.735Z",
    "updated_at": "2024-03-21T14:40:49.738Z",
    "version": 1711032049,
    "details": [
      {
        "id": "416087569088906916",
        "administration_id": 123,
        "tax_rate_id": "416087569079469730",
        "ledger_account_id": "416087569075275425",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:49.737Z",
        "updated_at": "2024-03-21T14:40:49.737Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087569079469730",
        "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": "416087569336370881",
    "administration_id": 123,
    "contact_id": "416087569319593662",
    "contact": {
      "id": "416087569319593662",
      "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": "31dbdf1f262cfce32a20b81a7ff50f791040bcbc4a0e232687d587f2118371f4",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:49.956Z",
      "updated_at": "2024-03-21T14:40:49.956Z",
      "version": 1711032049,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/468bb3ca111e91ccebcebe3fcde86dd0e771076cc6fd5a7738909ae614e3c092/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.972Z",
    "updated_at": "2024-03-21T14:40:49.975Z",
    "version": 1711032049,
    "details": [
      {
        "id": "416087569337419458",
        "administration_id": 123,
        "tax_rate_id": "416087569327982272",
        "ledger_account_id": "416087569324836543",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:49.974Z",
        "updated_at": "2024-03-21T14:40:49.974Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087569327982272",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "416087569305962170",
    "administration_id": 123,
    "contact_id": "416087569287087799",
    "contact": {
      "id": "416087569287087799",
      "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": "b12ff947655de675875b0711713b8916a656b978a01dd53cc0debf17f7cd713d",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:49.926Z",
      "updated_at": "2024-03-21T14:40:49.926Z",
      "version": 1711032049,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8f149c7b058135539f1aa3dd9ba858be5070819faaa24ab1c4032355e3a13d90/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:49.944Z",
    "updated_at": "2024-03-21T14:40:49.948Z",
    "version": 1711032049,
    "details": [
      {
        "id": "416087569308059323",
        "administration_id": 123,
        "tax_rate_id": "416087569296524985",
        "ledger_account_id": "416087569293379256",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:49.945Z",
        "updated_at": "2024-03-21T14:40:49.945Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087569296524985",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "416087569274504883",
    "administration_id": 123,
    "contact_id": "416087569254581936",
    "contact": {
      "id": "416087569254581936",
      "administration_id": 123,
      "company_name": "Relation 1",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "52357ca86d60fb2d09b871582cd9e7362182236e23d2f545486bacda9c0812c0",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:49.894Z",
      "updated_at": "2024-03-21T14:40:49.894Z",
      "version": 1711032049,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/54d5f6dbb17e3be0cbbee498a82db035a5be0fa1c65ca51669fab2924a4f455a/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 1",
    "entry_number": 101,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-03-21T14:40:49.913Z",
    "updated_at": "2024-03-21T14:40:49.917Z",
    "version": 1711032049,
    "details": [
      {
        "id": "416087569275553460",
        "administration_id": 123,
        "tax_rate_id": "416087569264019122",
        "ledger_account_id": "416087569260873393",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:49.915Z",
        "updated_at": "2024-03-21T14:40:49.915Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087569264019122",
        "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": "416087569552377563",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:50.178Z",
    "updated_at": "2024-03-21T14:40:50.178Z",
    "version": 1711032050,
    "details": [

    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "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": "416087569742169839",
    "administration_id": 123,
    "contact_id": "416087569725392620",
    "contact": {
      "id": "416087569725392620",
      "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": "0e7af51264a513d367baead28d1f3b491aa18010a8f3136eeaea5afaa9c68e82",
      "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,
      "moneybird_payments_mandate": false,
      "created_at": "2024-03-21T14:40:50.343Z",
      "updated_at": "2024-03-21T14:40:50.343Z",
      "version": 1711032050,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5d3dc86d96faa5a0a87fc7ead1d4cd7eeff39bdc8cfb30ce7d014d57a99273ac/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-03-21",
    "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": "2024-03-21T14:40:50.360Z",
    "updated_at": "2024-03-21T14:40:50.363Z",
    "version": 1711032050,
    "details": [
      {
        "id": "416087569744266992",
        "administration_id": 123,
        "tax_rate_id": "416087569733781230",
        "ledger_account_id": "416087569730635501",
        "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": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-03-21T14:40:50.361Z",
        "updated_at": "2024-03-21T14:40:50.361Z"
      }
    ],
    "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",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "416087569733781230",
        "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

GET /external_sales_invoices/:id(.:format)

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/416087570229757734.json?

Response

        
          
          Status: 200 OK
        
      
{
  "id": "416087570229757734",
  "administration_id": 123,
  "contact_id": "416087570209834787",
  "contact": {
    "id": "416087570209834787",
    "administration_id": 123,
    "company_name": "Relation 1",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "1db962c71eea8f7ecdcc37439c83337ef36dffce60ea425e33c170ddbcaa3c5c",
    "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,
    "moneybird_payments_mandate": false,
    "created_at": "2024-03-21T14:40:50.805Z",
    "updated_at": "2024-03-21T14:40:50.805Z",
    "version": 1711032050,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/200c32fb482c6bdc00bfdb8487a8916d06ab089fe43b88b27f0aa9d91ad46304/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-03-21",
  "state": "open",
  "due_date": null,
  "reference": "Invoice 1",
  "entry_number": 101,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-03-21T14:40:50.824Z",
  "updated_at": "2024-03-21T14:40:50.828Z",
  "version": 1711032050,
  "details": [
    {
      "id": "416087570231854887",
      "administration_id": 123,
      "tax_rate_id": "416087570220320549",
      "ledger_account_id": "416087570216126244",
      "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": [

      ],
      "mandatory_tax_text": null,
      "created_at": "2024-03-21T14:40:50.826Z",
      "updated_at": "2024-03-21T14:40:50.826Z"
    }
  ],
  "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",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [

  ],
  "tax_totals": [
    {
      "tax_rate_id": "416087570220320549",
      "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

POST /external_sales_invoices(.:format)

Parameters

Parameter Type Description
external_sales_invoice[contact_id] Integer

Should be a valid contact id.
external_sales_invoice[reference] String
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":416087570457298743,"details_attributes":[{"description":"Rocking Chair","price":129.95}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices

Response

        
          
          Status: 201 Created
        
      
{
  "id": "416087570532796217",
  "administration_id": 123,
  "contact_id": "416087570457298743",
  "contact": {
    "id": "416087570457298743",
    "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": "aa15e082ac60eeddd632f0c0c7ec5e2fb0d11eaea4dd07f7efb5eb8f4fcc92c6",
    "tax_number": "BE0464995729",
    "chamber_of_commerce": null,
    "bank_account": null,
    "attention": null,
    "email": "invoices@example.com",
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": "invoices@example.com",
    "send_estimates_to_attention": null,
    "send_estimates_to_email": "estimates@example.com",
    "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": "2024-03-21T14:40:51.039Z",
    "tax_number_valid": true,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-03-21T14:40:51.041Z",
    "updated_at": "2024-03-21T14:40:51.041Z",
    "version": 1711032051,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1bf1b6ec8f67d2f3837551082e53cbd0fbca04ea26cbf9f85f4747b9a4a6f1b2/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-03-21",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-03-21T14:40:51.113Z",
  "updated_at": "2024-03-21T14:40:51.117Z",
  "version": 1711032051,
  "details": [
    {
      "id": "416087570534893370",
      "administration_id": 123,
      "tax_rate_id": "416087461198825343",
      "ledger_account_id": "416087461088724843",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "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"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-03-21T14:40:51.115Z",
      "updated_at": "2024-03-21T14:40:51.115Z"
    }
  ],
  "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",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:40:51.119Z",
      "updated_at": "2024-03-21T14:40:51.119Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "416087461198825343",
      "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":416087570876729170,"currency":"USD","details_attributes":[{"description":"Rocking Chair","price":159.99,"tax_rate_id":416087570870437712}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices

Response

        
          
          Status: 201 Created
        
      
{
  "id": "416087570942789460",
  "administration_id": 123,
  "contact_id": "416087570876729170",
  "contact": {
    "id": "416087570876729170",
    "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": "ec4e588221f8db749314e9edc102bb5e94ccec0302d74deee2d4da802d75908a",
    "tax_number": "BE0464995729",
    "chamber_of_commerce": null,
    "bank_account": null,
    "attention": null,
    "email": "invoices@example.com",
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": "invoices@example.com",
    "send_estimates_to_attention": null,
    "send_estimates_to_email": "estimates@example.com",
    "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": "2024-03-21T14:40:51.438Z",
    "tax_number_valid": true,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-03-21T14:40:51.441Z",
    "updated_at": "2024-03-21T14:40:51.441Z",
    "version": 1711032051,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0dc5d8e13494a06c32b19635829e031a30454f4e8ad9d4a0ebe3b8998c383076/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-03-21",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "USD",
  "paid_at": null,
  "created_at": "2024-03-21T14:40:51.504Z",
  "updated_at": "2024-03-21T14:40:51.508Z",
  "version": 1711032051,
  "details": [
    {
      "id": "416087570944886613",
      "administration_id": 123,
      "tax_rate_id": "416087570870437712",
      "ledger_account_id": "416087461088724843",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "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/3a"
      ],
      "mandatory_tax_text": "Intra-Community supply, article 138(1), VAT Directive 2006/112",
      "created_at": "2024-03-21T14:40:51.506Z",
      "updated_at": "2024-03-21T14:40:51.506Z"
    }
  ],
  "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",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:40:51.510Z",
      "updated_at": "2024-03-21T14:40:51.510Z"
    }
  ],
  "tax_totals": [

  ]
}

Create external sales invoice from attachment

POST /external_sales_invoices/attachment(.:format)

Example: creates a new external sales invoice when uploading an attachment

Request

curl -s -H "Content-Type: multipart/mixed" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -F file=@/tmp/upload.pdf \
  https://moneybird.com/api/v2/123/external_sales_invoices/attachment.json

Response

        
          
          Status: 200 OK
        
      
200

Add attachment to external sales invoice

POST /external_sales_invoices/:id/attachment(.:format)

Example: adds an attachment to an existing external sales invoice

Request

curl -s -H "Content-Type: multipart/mixed" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -F file=@/tmp/upload.pdf \
  https://moneybird.com/api/v2/123/external_sales_invoices/416087573254899572/attachment.json

Response

        
          
          Status: 200 OK
        
      
200

Update an external sales invoice

PATCH /external_sales_invoices/:id(.:format)

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "416087573851539324",
  "administration_id": 123,
  "contact_id": "416087573829519225",
  "contact": {
    "id": "416087573829519225",
    "administration_id": 123,
    "company_name": "Relation 1",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "fed6819e6bfc413ff3f9bbc71260f12ba1cfeab6072b2c9a27d816bbca5172e2",
    "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,
    "moneybird_payments_mandate": false,
    "created_at": "2024-03-21T14:40:54.257Z",
    "updated_at": "2024-03-21T14:40:54.257Z",
    "version": 1711032054,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e32d239663e022145a603beb922f23458a61c97a1182ea22576b23c3070e0880/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-03-21",
  "state": "open",
  "due_date": null,
  "reference": "30053",
  "entry_number": 1,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-03-21T14:40:54.279Z",
  "updated_at": "2024-03-21T14:40:54.354Z",
  "version": 1711032054,
  "details": [
    {
      "id": "416087573853636477",
      "administration_id": 123,
      "tax_rate_id": "416087573841053563",
      "ledger_account_id": "416087573836859258",
      "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"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-03-21T14:40:54.281Z",
      "updated_at": "2024-03-21T14:40:54.352Z"
    }
  ],
  "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",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:40:54.356Z",
      "updated_at": "2024-03-21T14:40:54.356Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "416087573841053563",
      "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":416087574116829062,"_destroy":true}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/416087574113683333

Response

        
          
          Status: 200 OK
        
      
{
  "id": "416087574113683333",
  "administration_id": 123,
  "contact_id": "416087574088517506",
  "contact": {
    "id": "416087574088517506",
    "administration_id": 123,
    "company_name": "Relation 1",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "6045ff032b87aa7ed7b070b94a888163204deb61b1b627b5a67d8c7f5c9ea30b",
    "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,
    "moneybird_payments_mandate": false,
    "created_at": "2024-03-21T14:40:54.501Z",
    "updated_at": "2024-03-21T14:40:54.501Z",
    "version": 1711032054,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/eb0d1d30a0817ff27e59e17db978ebbf5ceb10c69602e615c28f90bbd8e340ef/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-03-21",
  "state": "open",
  "due_date": null,
  "reference": "Invoice 1",
  "entry_number": 1,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-03-21T14:40:54.528Z",
  "updated_at": "2024-03-21T14:40:54.630Z",
  "version": 1711032054,
  "details": [
    {
      "id": "416087574217492360",
      "administration_id": 123,
      "tax_rate_id": "416087461198825343",
      "ledger_account_id": "416087461088724843",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "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"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-03-21T14:40:54.626Z",
      "updated_at": "2024-03-21T14:40:54.626Z"
    }
  ],
  "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",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:40:54.633Z",
      "updated_at": "2024-03-21T14:40:54.633Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "416087461198825343",
      "taxable_amount": "199.99",
      "taxable_amount_base": "199.99",
      "tax_amount": "42.0",
      "tax_amount_base": "42.0"
    }
  ]
}

Delete an external sales invoice

DELETE /external_sales_invoices/:id(.:format)

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

Response

        
          
          Status: 204 No Content

Mark as dubious

PATCH /external_sales_invoices/:id/mark_as_dubious(.:format)

This endpoint marks an external sales invoice as dubious.

Parameters

Parameter Type Description
dubious_date Date

Mark as uncollectible

PATCH /external_sales_invoices/:id/mark_as_uncollectible(.:format)

This endpoint marks an external sales invoice as uncollectible.

Parameters

Parameter Type Description
uncollectible_date Date
book_method String

Can be revenue.

Adds note to entity

POST /external_sales_invoices/:external_sales_invoice_id/notes(.:format)

Parameters

Parameter Type Description
note[note] String

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

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

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

Example: create a note

Request

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

Response

        
          
          Status: 201 Created
        
      
{
  "id": "416087575708567480",
  "administration_id": 123,
  "entity_id": "416087575634118580",
  "entity_type": "ExternalSalesInvoice",
  "user_id": 17110319469471,
  "assignee_id": "416087575645652918",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {
  },
  "created_at": "2024-03-21T14:40:56.049Z",
  "updated_at": "2024-03-21T14:40:56.049Z"
}

Destroys note from entity

DELETE /external_sales_invoices/:external_sales_invoice_id/notes/:id(.:format)

Example: destroy a note

Request

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

Response

        
          
          Status: 204 No Content

Create a payment

POST /external_sales_invoices/:external_sales_invoice_id/payments(.:format)

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
payment[manual_payment_action] String

Can be private_payment, payment_without_proof, cash_payment, rounding_error, bank_transfer, balance_settlement or invoices_settlement.
payment[ledger_account_id] Integer

Should be a valid ledger account id.
payment[invoice_id] Integer

Required

Example: create a payment

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"payment":{"payment_date":"2024-03-21 14:40:56 UTC","price":"121.0"}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/416087575919331273/payments.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "416087575970711499",
  "administration_id": 123,
  "invoice_type": "ExternalSalesInvoice",
  "invoice_id": "416087575919331273",
  "financial_account_id": null,
  "user_id": 17110319469471,
  "payment_transaction_id": null,
  "transaction_identifier": null,
  "price": "121.0",
  "price_base": "121.0",
  "payment_date": "2024-03-21",
  "credit_invoice_id": null,
  "financial_mutation_id": null,
  "ledger_account_id": "416087461152687990",
  "linked_payment_id": null,
  "manual_payment_action": null,
  "created_at": "2024-03-21T14:40:56.300Z",
  "updated_at": "2024-03-21T14:40:56.300Z"
}

Delete a payment

DELETE /external_sales_invoices/:external_sales_invoice_id/payments/:id(.:format)

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/416087576056694739/payments/416087576070326229.json

Response

        
          
          Status: 204 No Content

Download attachment

GET /external_sales_invoices/:external_sales_invoice_id/attachments/:id/download(.:format)

Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment.

Delete an attachment

DELETE /external_sales_invoices/:external_sales_invoice_id/attachments/:id(.:format)

Deletes an attachment of an attachable.

Example: destroys an attachment

Request

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

Response

        
          
          Status: 204 No Content