Sales invoices

List all invoices

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

The filter argument allows you to filter the list of 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, draft, open, scheduled, pending_payment, late, reminded, paid or uncollectible
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
recurring_sales_invoice_id Integer   Select invoices created by a certain recurring invoice
workflow_id Integer   Select invoices that use a certain workflow

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

Parameters

Parameter Type Description
filter String

Example: returns all invoices of an administration

Request

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

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903545377753020",
    "administration_id": 123,
    "contact_id": "181903544379508656",
    "contact": {
      "id": "181903544379508656",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:00.055Z",
      "updated_at": "2017-02-21T17:06:00.055Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/ccaa79c4da7b06eddbd92c10c0180f0c9f1b16ae5f7d09961066bfc5699c2559/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0003",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:01.009Z",
    "updated_at": "2017-02-21T17:06:01.208Z",
    "details": [
      {
        "id": "181903545380898749",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:01.013Z",
        "updated_at": "2017-02-21T17:06:01.204Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/b64b5152ec2993aa353713851c97c8f5980f203223d23ca247e30c27ad65d909/ccaa79c4da7b06eddbd92c10c0180f0c9f1b16ae5f7d09961066bfc5699c2559",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:01.022Z",
        "updated_at": "2017-02-21T17:06:01.022Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:01.264Z",
        "updated_at": "2017-02-21T17:06:01.264Z"
      }
    ]
  },
  {
    "id": "181903544997119928",
    "administration_id": 123,
    "contact_id": "181903544379508656",
    "contact": {
      "id": "181903544379508656",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:00.055Z",
      "updated_at": "2017-02-21T17:06:00.055Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/ccaa79c4da7b06eddbd92c10c0180f0c9f1b16ae5f7d09961066bfc5699c2559/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0002",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:00.646Z",
    "updated_at": "2017-02-21T17:06:00.847Z",
    "details": [
      {
        "id": "181903545001314233",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:00.650Z",
        "updated_at": "2017-02-21T17:06:00.844Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/e12794f4e85e43753b86fda70257d78315023d21a2e7cbfa0739e73b40e9adda/ccaa79c4da7b06eddbd92c10c0180f0c9f1b16ae5f7d09961066bfc5699c2559",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:00.659Z",
        "updated_at": "2017-02-21T17:06:00.659Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:00.904Z",
        "updated_at": "2017-02-21T17:06:00.904Z"
      }
    ]
  },
  {
    "id": "181903544536795059",
    "administration_id": 123,
    "contact_id": "181903544379508656",
    "contact": {
      "id": "181903544379508656",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:00.055Z",
      "updated_at": "2017-02-21T17:06:00.055Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/ccaa79c4da7b06eddbd92c10c0180f0c9f1b16ae5f7d09961066bfc5699c2559/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0001",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:00.207Z",
    "updated_at": "2017-02-21T17:06:00.495Z",
    "details": [
      {
        "id": "181903544544135092",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": "20170201..20170228",
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:00.213Z",
        "updated_at": "2017-02-21T17:06:00.492Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/0f826514515f1a47d8b2277669b38b22fb573023d3ca7ca197d10ab5deb3aabf/ccaa79c4da7b06eddbd92c10c0180f0c9f1b16ae5f7d09961066bfc5699c2559",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:00.227Z",
        "updated_at": "2017-02-21T17:06:00.227Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:00.552Z",
        "updated_at": "2017-02-21T17:06:00.552Z"
      }
    ]
  }
]
      

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/sales_invoices.json?filter=period%3Athis_month
    

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903546691618766",
    "administration_id": 123,
    "contact_id": "181903545846466498",
    "contact": {
      "id": "181903545846466498",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:01.457Z",
      "updated_at": "2017-02-21T17:06:01.457Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/db81b8050404683752193f0d61cb70ef94ea470e7443a429babea354bdfddde3/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0003",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:02.262Z",
    "updated_at": "2017-02-21T17:06:02.463Z",
    "details": [
      {
        "id": "181903546695813071",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:02.266Z",
        "updated_at": "2017-02-21T17:06:02.460Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/3912ed720055a0827345796153f3340a9062ee880c63ca7e963809e65ba0919d/db81b8050404683752193f0d61cb70ef94ea470e7443a429babea354bdfddde3",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:02.274Z",
        "updated_at": "2017-02-21T17:06:02.274Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:02.513Z",
        "updated_at": "2017-02-21T17:06:02.513Z"
      }
    ]
  },
  {
    "id": "181903546313082826",
    "administration_id": 123,
    "contact_id": "181903545846466498",
    "contact": {
      "id": "181903545846466498",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:01.457Z",
      "updated_at": "2017-02-21T17:06:01.457Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/db81b8050404683752193f0d61cb70ef94ea470e7443a429babea354bdfddde3/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0002",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:01.902Z",
    "updated_at": "2017-02-21T17:06:02.107Z",
    "details": [
      {
        "id": "181903546317277131",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:01.905Z",
        "updated_at": "2017-02-21T17:06:02.104Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/dab62c13fd4e12314362e6ec4a4c0c79f3dd3a2a6b5c5c88a9bb6719b1ed4818/db81b8050404683752193f0d61cb70ef94ea470e7443a429babea354bdfddde3",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:01.913Z",
        "updated_at": "2017-02-21T17:06:01.913Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:02.162Z",
        "updated_at": "2017-02-21T17:06:02.162Z"
      }
    ]
  },
  {
    "id": "181903545950275525",
    "administration_id": 123,
    "contact_id": "181903545846466498",
    "contact": {
      "id": "181903545846466498",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:01.457Z",
      "updated_at": "2017-02-21T17:06:01.457Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/db81b8050404683752193f0d61cb70ef94ea470e7443a429babea354bdfddde3/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0001",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:01.555Z",
    "updated_at": "2017-02-21T17:06:01.760Z",
    "details": [
      {
        "id": "181903545953421254",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": "20170201..20170228",
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:01.559Z",
        "updated_at": "2017-02-21T17:06:01.757Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/0c278cce4016f94cfadf1aca6b247b2b8e47379b75e5746201582560955350e6/db81b8050404683752193f0d61cb70ef94ea470e7443a429babea354bdfddde3",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:01.567Z",
        "updated_at": "2017-02-21T17:06:01.567Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:01.810Z",
        "updated_at": "2017-02-21T17:06:01.810Z"
      }
    ]
  }
]
      

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/sales_invoices.json?filter=state%3Alate
    

Response

Example: returns paginated sales invoices on page 1

Request

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

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903549420013554",
    "administration_id": 123,
    "contact_id": "181903548552841190",
    "contact": {
      "id": "181903548552841190",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:04.037Z",
      "updated_at": "2017-02-21T17:06:04.037Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/6205c73614a3e8946938c3d3e334fcbc70e18b987d8016f986da7914517e24e4/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0003",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:04.864Z",
    "updated_at": "2017-02-21T17:06:05.057Z",
    "details": [
      {
        "id": "181903549424207859",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:04.868Z",
        "updated_at": "2017-02-21T17:06:05.053Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/88d502b598cba067b32ecbdde244df25bd1c60267599ed923edbf43535cf531f/6205c73614a3e8946938c3d3e334fcbc70e18b987d8016f986da7914517e24e4",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:04.876Z",
        "updated_at": "2017-02-21T17:06:04.876Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:05.107Z",
        "updated_at": "2017-02-21T17:06:05.107Z"
      }
    ]
  }
]
      

Example: returns paginated sales invoices on page 2

Request

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

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903550337516544",
    "administration_id": 123,
    "contact_id": "181903549854124024",
    "contact": {
      "id": "181903549854124024",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:05.277Z",
      "updated_at": "2017-02-21T17:06:05.277Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/ed14d217d4eaf55bb2f7fc76f05b438ffc9afa85e5a15ad2046f8c8ec16cf25d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0002",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:05.738Z",
    "updated_at": "2017-02-21T17:06:05.959Z",
    "details": [
      {
        "id": "181903550341710849",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:05.743Z",
        "updated_at": "2017-02-21T17:06:05.956Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/3649e9e68335e30b2d5b29d8131757fd088a1c8e5acd3e26ab829b97cbadaf67/ed14d217d4eaf55bb2f7fc76f05b438ffc9afa85e5a15ad2046f8c8ec16cf25d",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:05.753Z",
        "updated_at": "2017-02-21T17:06:05.753Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:06.018Z",
        "updated_at": "2017-02-21T17:06:06.018Z"
      }
    ]
  }
]
      

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

Request

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

Response

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

List all ids and versions

Returns all sales invoices in the administration. The list contains the invoice id and the version of the invoice. Check if the version of the invoice is newer than the version you have stored locally, use the POST variant for fetching invoices with the given ids.

Parameters

Parameter Type Description
filter String

Example: retrieves the id's for synchronization

Request

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

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903571456886128",
    "version": 1487696785
  },
  {
    "id": "181903571024872812",
    "version": 1487696785
  },
  {
    "id": "181903570626413928",
    "version": 1487696785
  }
]
      

Example: retrieves the id's for synchronization with a filter

Request

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

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903572847297921",
    "version": 1487696787
  },
  {
    "id": "181903572151043453",
    "version": 1487696786
  },
  {
    "id": "181903571699107192",
    "version": 1487696786
  }
]
      

Fetch sales invoices with given ids

Given a list of sales invoice ids, returns the sales invoice information belonging to the invoices. Returns a maximum of 100 invoice, even if more ids are provided.

Parameters

Parameter Type Description
ids Array[integer]

Required

Example: retrieves recurring sales invoices given by IDs

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"ids":[181903543323592614,181903543434741674]}' \
  https://moneybird.com/api/v2/123/recurring_sales_invoices/synchronization.json
    

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903543434741674",
    "administration_id": 123,
    "contact_id": "181903543237609380",
    "contact": {
      "id": "181903543237609380",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "2",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:05:58.968Z",
      "updated_at": "2017-02-21T17:05:58.968Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/f3a0a270a0c51dc39bf495b737e1548f99913d19bdba95a57b2566199aa7a3fd/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "workflow_id": "181903403083892150",
    "start_date": "2017-02-22",
    "invoice_date": "2017-02-22",
    "last_date": "2017-02-22",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "month",
    "frequency": 1,
    "created_at": "2017-02-21T17:05:59.156Z",
    "updated_at": "2017-02-21T17:05:59.170Z",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "181903543438935979",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "5 stuks",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:05:59.160Z",
        "updated_at": "2017-02-21T17:05:59.160Z"
      },
      {
        "id": "181903543445227436",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "2 stuks",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:05:59.166Z",
        "updated_at": "2017-02-21T17:05:59.166Z"
      }
    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:05:59.174Z",
        "updated_at": "2017-02-21T17:05:59.174Z"
      }
    ]
  },
  {
    "id": "181903543323592614",
    "administration_id": 123,
    "contact_id": "181903543237609380",
    "contact": {
      "id": "181903543237609380",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "2",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:05:58.968Z",
      "updated_at": "2017-02-21T17:05:58.968Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/f3a0a270a0c51dc39bf495b737e1548f99913d19bdba95a57b2566199aa7a3fd/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "workflow_id": "181903403083892150",
    "start_date": "2017-02-22",
    "invoice_date": "2017-02-22",
    "last_date": "2017-02-22",
    "active": true,
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "first_due_interval": 14,
    "auto_send": false,
    "sending_scheduled_at": null,
    "sending_scheduled_user_id": null,
    "frequency_type": "year",
    "frequency": 1,
    "created_at": "2017-02-21T17:05:59.049Z",
    "updated_at": "2017-02-21T17:05:59.061Z",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "2.91",
    "total_price_excl_tax_base": "2.91",
    "total_price_incl_tax": "3.52",
    "total_price_incl_tax_base": "3.52",
    "details": [
      {
        "id": "181903543327786919",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "5 stuks",
        "description": "Appels",
        "price": "0.45",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "2.25",
        "total_price_excl_tax_with_discount_base": "2.25",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:05:59.054Z",
        "updated_at": "2017-02-21T17:05:59.054Z"
      },
      {
        "id": "181903543330932648",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "2 stuks",
        "description": "Peren",
        "price": "0.33",
        "period": null,
        "row_order": 2,
        "total_price_excl_tax_with_discount": "0.66",
        "total_price_excl_tax_with_discount_base": "0.66",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:05:59.058Z",
        "updated_at": "2017-02-21T17:05:59.058Z"
      }
    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "recurring_sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:05:59.067Z",
        "updated_at": "2017-02-21T17:05:59.067Z"
      }
    ]
  }
]
      

Example: retrieves sales invoices given by ids

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"ids":[181903574912992658,181903575510680982]}' \
  https://moneybird.com/api/v2/123/sales_invoices/synchronization.json
    

Response

        
          Status: 200 OK
          
        
      
      [
  {
    "id": "181903575510680982",
    "administration_id": 123,
    "contact_id": "181903574181086602",
    "contact": {
      "id": "181903574181086602",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:28.478Z",
      "updated_at": "2017-02-21T17:06:28.478Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/105077243a24455391bcab4dc33c1632342e479a0606097b6cca67183cccc144/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0003",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:29.743Z",
    "updated_at": "2017-02-21T17:06:30.001Z",
    "details": [
      {
        "id": "181903575516972439",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:29.752Z",
        "updated_at": "2017-02-21T17:06:29.996Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/05efd47105c64e4b332b07b12a47d0b594f260648997321ba38e04e48f348cf4/105077243a24455391bcab4dc33c1632342e479a0606097b6cca67183cccc144",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:30.110Z",
        "updated_at": "2017-02-21T17:06:30.110Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:29.764Z",
        "updated_at": "2017-02-21T17:06:29.764Z"
      }
    ]
  },
  {
    "id": "181903574912992658",
    "administration_id": 123,
    "contact_id": "181903574181086602",
    "contact": {
      "id": "181903574181086602",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "created_at": "2017-02-21T17:06:28.478Z",
      "updated_at": "2017-02-21T17:06:28.478Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/105077243a24455391bcab4dc33c1632342e479a0606097b6cca67183cccc144/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "invoice_id": "2017-0002",
    "recurring_sales_invoice_id": null,
    "workflow_id": "181903403083892150",
    "document_style_id": "181903403938481600",
    "identity_id": "181903402453697973",
    "draft_id": null,
    "state": "open",
    "invoice_date": "2017-02-21",
    "due_date": "2017-03-07",
    "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
    "reference": "Project X",
    "language": "nl",
    "currency": "EUR",
    "discount": "0.0",
    "original_sales_invoice_id": null,
    "paid_at": null,
    "sent_at": "2017-02-21",
    "created_at": "2017-02-21T17:06:29.176Z",
    "updated_at": "2017-02-21T17:06:29.403Z",
    "details": [
      {
        "id": "181903574917186963",
        "administration_id": 123,
        "tax_rate_id": "181903402082502063",
        "ledger_account_id": "181903401873835420",
        "amount": "1 x",
        "description": "Project X",
        "price": "300.0",
        "period": null,
        "row_order": 1,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/1a"
        ],
        "created_at": "2017-02-21T17:06:29.181Z",
        "updated_at": "2017-02-21T17:06:29.399Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "363.0",
    "total_unpaid_base": "363.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "url": "http://moneybird.dev/123/sales_invoices/2675dcff318caa5eb04ab072c89dd158a1d20d200d666473d8805f91311cf280/105077243a24455391bcab4dc33c1632342e479a0606097b6cca67183cccc144",
    "custom_fields": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_send_email",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
          "email_address": "info@example.com",
          "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
        },
        "created_at": "2017-02-21T17:06:29.472Z",
        "updated_at": "2017-02-21T17:06:29.472Z"
      },
      {
        "administration_id": 123,
        "user_id": 14876966215920,
        "action": "sales_invoice_created",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-02-21T17:06:29.189Z",
        "updated_at": "2017-02-21T17:06:29.189Z"
      }
    ]
  }
]
      

Get an invoice by id

Example: returns invoice by given id

Request

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

Response

        
          Status: 200 OK
          
        
      
      {
  "id": "181903552510166047",
  "administration_id": 123,
  "contact_id": "181903552404259868",
  "contact": {
    "id": "181903552404259868",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "created_at": "2017-02-21T17:06:07.710Z",
    "updated_at": "2017-02-21T17:06:07.710Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/e807722dc8338cfa5b7ca895a78bd49868385b145730027758013f7a780a7890/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "invoice_id": "2017-0001",
  "recurring_sales_invoice_id": null,
  "workflow_id": "181903403083892150",
  "document_style_id": "181903403938481600",
  "identity_id": "181903402453697973",
  "draft_id": null,
  "state": "open",
  "invoice_date": "2017-02-21",
  "due_date": "2017-03-07",
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Project X",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": null,
  "paid_at": null,
  "sent_at": "2017-02-21",
  "created_at": "2017-02-21T17:06:07.811Z",
  "updated_at": "2017-02-21T17:06:08.005Z",
  "details": [
    {
      "id": "181903552513311776",
      "administration_id": 123,
      "tax_rate_id": "181903402082502063",
      "ledger_account_id": "181903401873835420",
      "amount": "1 x",
      "description": "Project X",
      "price": "300.0",
      "period": "20170201..20170228",
      "row_order": 1,
      "total_price_excl_tax_with_discount": "300.0",
      "total_price_excl_tax_with_discount_base": "300.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2017-02-21T17:06:07.815Z",
      "updated_at": "2017-02-21T17:06:08.002Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "363.0",
  "total_unpaid_base": "363.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "300.0",
  "total_price_excl_tax_base": "300.0",
  "total_price_incl_tax": "363.0",
  "total_price_incl_tax_base": "363.0",
  "url": "http://moneybird.dev/123/sales_invoices/7090c100b6c2c3a3f0dfb7c5f21431c5fa5b40817c091e4b1941234cc209d8ea/e807722dc8338cfa5b7ca895a78bd49868385b145730027758013f7a780a7890",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-02-21T17:06:07.822Z",
      "updated_at": "2017-02-21T17:06:07.822Z"
    },
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_send_email",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "email_address": "info@example.com",
        "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
      },
      "created_at": "2017-02-21T17:06:08.063Z",
      "updated_at": "2017-02-21T17:06:08.063Z"
    }
  ]
}
      

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

Response

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

Get an invoice by invoice_id

Example: returns invoice by given id

Request

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

Response

        
          Status: 200 OK
          
        
      
      {
  "id": "181903553579713587",
  "administration_id": 123,
  "contact_id": "181903553466467376",
  "contact": {
    "id": "181903553466467376",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "created_at": "2017-02-21T17:06:08.723Z",
    "updated_at": "2017-02-21T17:06:08.723Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/2bbd3e278e1ba59f858b253571047f248aff5b8189c33f154629a197a2bafaaa/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "invoice_id": "2017-0001",
  "recurring_sales_invoice_id": null,
  "workflow_id": "181903403083892150",
  "document_style_id": "181903403938481600",
  "identity_id": "181903402453697973",
  "draft_id": null,
  "state": "open",
  "invoice_date": "2017-02-21",
  "due_date": "2017-03-07",
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Project X",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": null,
  "paid_at": null,
  "sent_at": "2017-02-21",
  "created_at": "2017-02-21T17:06:08.831Z",
  "updated_at": "2017-02-21T17:06:09.027Z",
  "details": [
    {
      "id": "181903553582859316",
      "administration_id": 123,
      "tax_rate_id": "181903402082502063",
      "ledger_account_id": "181903401873835420",
      "amount": "1 x",
      "description": "Project X",
      "price": "300.0",
      "period": null,
      "row_order": 1,
      "total_price_excl_tax_with_discount": "300.0",
      "total_price_excl_tax_with_discount_base": "300.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2017-02-21T17:06:08.835Z",
      "updated_at": "2017-02-21T17:06:09.024Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "363.0",
  "total_unpaid_base": "363.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "300.0",
  "total_price_excl_tax_base": "300.0",
  "total_price_incl_tax": "363.0",
  "total_price_incl_tax_base": "363.0",
  "url": "http://moneybird.dev/123/sales_invoices/c25dd122a9aeb11690f055c8d390ee9551992d7ab3d2825d82b554e4e1c60b21/2bbd3e278e1ba59f858b253571047f248aff5b8189c33f154629a197a2bafaaa",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-02-21T17:06:08.843Z",
      "updated_at": "2017-02-21T17:06:08.843Z"
    },
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_send_email",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "email_address": "info@example.com",
        "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
      },
      "created_at": "2017-02-21T17:06:09.084Z",
      "updated_at": "2017-02-21T17:06:09.084Z"
    }
  ]
}
      

Example: returns 404 when the given invoice_id does not exist

Request

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

Response

        
          Status: 404 Not Found
          
        
      
      {
  "error": "Sales invoice with invoice_id: 1337 was not found",
  "symbolic": {
    "invoice_id": "not_found"
  }
}
      

Creates a new invoice

Parameters

Parameter Type Description
sales_invoice[contact_id] Integer

Should be a valid contact id.

sales_invoice[update_contact] Boolean
sales_invoice[recurring_sales_invoice_id] Integer

Should be a valid recurring sales invoice id.

sales_invoice[original_estimate_id] Integer
sales_invoice[document_style_id] Integer

Required

Default document style is used if value is not provided. Should be a valid document style id.

sales_invoice[workflow_id] Integer

Required

If value is not provided, the workflow saved in the contact is used. If the contact doesn’t have a default workflow, the administration’s default workflow is used. Should be a valid workflow id.

sales_invoice[reference] String
sales_invoice[invoice_sequence_id] String

The {id} part of the invoice identifier.

sales_invoice[remove_invoice_sequence_id] Boolean
sales_invoice[invoice_date] String
sales_invoice[first_due_interval] Integer
sales_invoice[currency] String

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

sales_invoice[prices_are_incl_tax] Boolean
sales_invoice[payment_conditions] String
sales_invoice[discount] Decimal

Discount percentage, e.g. 10,0%. Should be a number 0 <= n <= 100.

sales_invoice[details_attributes][*][id] Integer

Should be a valid detail id.

sales_invoice[details_attributes][*][description] String
sales_invoice[details_attributes][*][period] String

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

sales_invoice[details_attributes][*][price] Decimal

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

sales_invoice[details_attributes][*][amount] String
sales_invoice[details_attributes][*][tax_rate_id] Integer

Should be a valid tax rate id.

sales_invoice[details_attributes][*][ledger_account_id] Integer

Should be a valid ledger account id.

sales_invoice[details_attributes][*][product_id] Integer

Should be a valid product id.

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

Should be a valid custom field id.

sales_invoice[custom_fields_attributes][*][value] String
preview Boolean
user_agent String

Example: creates a new invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"sales_invoice":{"reference":"My first invoice","contact_id":181903554554889284,"details_attributes":{"0":{"description":"Table","price":"10.5"}}}}' \
  https://moneybird.com/api/v2/123/sales_invoices.json
    

Response

        
          Status: 201 Created
          
        
      
      {
  "id": "181903555083371596",
  "administration_id": 123,
  "contact_id": "181903554554889284",
  "contact": {
    "id": "181903554554889284",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "created_at": "2017-02-21T17:06:09.761Z",
    "updated_at": "2017-02-21T17:06:09.761Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/d9b91eca196498780e440d3807799d5ed4f2c3a36cfd728cae92e384d8669f8f/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "invoice_id": null,
  "recurring_sales_invoice_id": null,
  "workflow_id": "181903403083892150",
  "document_style_id": "181903403938481600",
  "identity_id": "181903402453697973",
  "draft_id": 2,
  "state": "draft",
  "invoice_date": null,
  "due_date": "2017-03-07",
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "My first invoice",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": null,
  "paid_at": null,
  "sent_at": null,
  "created_at": "2017-02-21T17:06:10.265Z",
  "updated_at": "2017-02-21T17:06:10.272Z",
  "details": [
    {
      "id": "181903555086517325",
      "administration_id": 123,
      "tax_rate_id": "181903402082502063",
      "ledger_account_id": "181903401873835420",
      "amount": null,
      "description": "Table",
      "price": "10.5",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "10.5",
      "total_price_excl_tax_with_discount_base": "10.5",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2017-02-21T17:06:10.269Z",
      "updated_at": "2017-02-21T17:06:10.269Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "12.71",
  "total_unpaid_base": "12.71",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "10.5",
  "total_price_excl_tax_base": "10.5",
  "total_price_incl_tax": "12.71",
  "total_price_incl_tax_base": "12.71",
  "url": "http://moneybird.dev/123/sales_invoices/e10714b51e116f59c8138d674ecf67319a235b4bd86ea971201a6219ba7c6116/d9b91eca196498780e440d3807799d5ed4f2c3a36cfd728cae92e384d8669f8f",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-02-21T17:06:10.276Z",
      "updated_at": "2017-02-21T17:06:10.276Z"
    }
  ]
}
      

Example: responds with a 402 code when the sales invoice limit is reached

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"sales_invoice":{"reference":"My first invoice","contact_id":181903555240658001,"details_attributes":{"0":{"description":"Table","price":"10.5"}}}}' \
  https://moneybird.com/api/v2/123/sales_invoices.json
    

Response

        
          Status: 402 Payment Required
          
        
      
      {
  "error": "creating sales invoices is limited",
  "symbolic": {
    "administration": "limit_reached"
  }
}
      

Example: returns an error when custom field cannot be found

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"sales_invoice":{"reference":"My first invoice","contact_id":181903555698885723,"details_attributes":{"0":{"description":"Table","price":"10.5"}},"custom_fields_attributes":{"0":{"id":1234,"value":"Field value"}}}}' \
  https://moneybird.com/api/v2/123/sales_invoices.json
    

Response

        
          Status: 404 Not Found
          
        
      
      {
  "error": "Custom field with id 1234 not found for administration",
  "symbolic": {
    "custom_fields_attributes": "not_found"
  }
}
      

Updates an invoice

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

Parameters

Parameter Type Description
sales_invoice[contact_id] Integer

Should be a valid contact id.

sales_invoice[update_contact] Boolean
sales_invoice[recurring_sales_invoice_id] Integer

Should be a valid recurring sales invoice id.

sales_invoice[original_estimate_id] Integer
sales_invoice[document_style_id] Integer

Default document style is used if value is not provided. Should be a valid document style id.

sales_invoice[workflow_id] Integer

If value is not provided, the workflow saved in the contact is used. If the contact doesn’t have a default workflow, the administration’s default workflow is used. Should be a valid workflow id.

sales_invoice[reference] String
sales_invoice[invoice_sequence_id] String

The {id} part of the invoice identifier.

sales_invoice[remove_invoice_sequence_id] Boolean
sales_invoice[invoice_date] String
sales_invoice[first_due_interval] Integer
sales_invoice[currency] String

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

sales_invoice[prices_are_incl_tax] Boolean
sales_invoice[payment_conditions] String
sales_invoice[discount] Decimal

Discount percentage, e.g. 10,0%. Should be a number 0 <= n <= 100.

sales_invoice[details_attributes][*][id] Integer

Should be a valid detail id.

sales_invoice[details_attributes][*][description] String
sales_invoice[details_attributes][*][period] String

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

sales_invoice[details_attributes][*][price] Decimal

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

sales_invoice[details_attributes][*][amount] String
sales_invoice[details_attributes][*][tax_rate_id] Integer

Should be a valid tax rate id.

sales_invoice[details_attributes][*][ledger_account_id] Integer

Should be a valid ledger account id.

sales_invoice[details_attributes][*][product_id] Integer

Should be a valid product id.

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

Should be a valid custom field id.

sales_invoice[custom_fields_attributes][*][value] String

Example: updates the reference

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"sales_invoice":{"reference":"Reference changed"}}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903556321739880.json
    

Response

        
          Status: 200 OK
          
        
      
      {
  "id": "181903556321739880",
  "administration_id": 123,
  "contact_id": "181903556214785125",
  "contact": {
    "id": "181903556214785125",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "created_at": "2017-02-21T17:06:11.344Z",
    "updated_at": "2017-02-21T17:06:11.344Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/75a806ef318b0f6090f2a94101489497b1c969c6cf51b5ac368863268f04f570/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "invoice_id": null,
  "recurring_sales_invoice_id": null,
  "workflow_id": "181903403083892150",
  "document_style_id": "181903403938481600",
  "identity_id": "181903402453697973",
  "draft_id": 1,
  "state": "draft",
  "invoice_date": null,
  "due_date": "2017-03-07",
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Reference changed",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": null,
  "paid_at": null,
  "sent_at": null,
  "created_at": "2017-02-21T17:06:11.446Z",
  "updated_at": "2017-02-21T17:06:11.563Z",
  "details": [
    {
      "id": "181903556325934185",
      "administration_id": 123,
      "tax_rate_id": "181903402082502063",
      "ledger_account_id": "181903401873835420",
      "amount": "1 x",
      "description": "Project X",
      "price": "300.0",
      "period": null,
      "row_order": 1,
      "total_price_excl_tax_with_discount": "300.0",
      "total_price_excl_tax_with_discount_base": "300.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2017-02-21T17:06:11.451Z",
      "updated_at": "2017-02-21T17:06:11.451Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "363.0",
  "total_unpaid_base": "363.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "300.0",
  "total_price_excl_tax_base": "300.0",
  "total_price_incl_tax": "363.0",
  "total_price_incl_tax_base": "363.0",
  "url": "http://moneybird.dev/123/sales_invoices/90e8a08ae1720c18a351f002bc68aea00b579275d26dcde59d1c910673a68cdd/75a806ef318b0f6090f2a94101489497b1c969c6cf51b5ac368863268f04f570",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-02-21T17:06:11.459Z",
      "updated_at": "2017-02-21T17:06:11.459Z"
    }
  ]
}
      

Example: updates invoice details

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"sales_invoice":{"details_attributes":{"0":{"description":"New detail","price":99,"amount":1,"tax_rate_id":181903402082502063,"ledger_account_id":181903401873835420},"1":{"id":181903556704470129,"_destroy":true}}}}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903556700275824.json
    

Response

        
          Status: 200 OK
          
        
      
      {
  "id": "181903556700275824",
  "administration_id": 123,
  "contact_id": "181903556593321069",
  "contact": {
    "id": "181903556593321069",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "created_at": "2017-02-21T17:06:11.705Z",
    "updated_at": "2017-02-21T17:06:11.705Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/00ebcbf63f02b0c9b07e3d9452077271605ced517c90b6bc9799cb9518578b34/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "invoice_id": null,
  "recurring_sales_invoice_id": null,
  "workflow_id": "181903403083892150",
  "document_style_id": "181903403938481600",
  "identity_id": "181903402453697973",
  "draft_id": 1,
  "state": "draft",
  "invoice_date": null,
  "due_date": "2017-03-07",
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Project X",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": null,
  "paid_at": null,
  "sent_at": null,
  "created_at": "2017-02-21T17:06:11.808Z",
  "updated_at": "2017-02-21T17:06:11.956Z",
  "details": [
    {
      "id": "181903556852319347",
      "administration_id": 123,
      "tax_rate_id": "181903402082502063",
      "ledger_account_id": "181903401873835420",
      "amount": "1",
      "description": "New detail",
      "price": "99.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "99.0",
      "total_price_excl_tax_with_discount_base": "99.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2017-02-21T17:06:11.953Z",
      "updated_at": "2017-02-21T17:06:11.953Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "119.79",
  "total_unpaid_base": "119.79",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "99.0",
  "total_price_excl_tax_base": "99.0",
  "total_price_incl_tax": "119.79",
  "total_price_incl_tax_base": "119.79",
  "url": "http://moneybird.dev/123/sales_invoices/e02dd9ac59bb7db5b0cbcfdca8f79efe428f691ead17192d9214bdfb5114aab5/00ebcbf63f02b0c9b07e3d9452077271605ced517c90b6bc9799cb9518578b34",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-02-21T17:06:11.819Z",
      "updated_at": "2017-02-21T17:06:11.819Z"
    }
  ]
}
      

Destroys an 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/sales_invoices/181903559474807983.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":14876966215920,"todo":true}}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903576201692575/notes.json
    

Response

        
          Status: 201 Created
          
        
      
      {
  "id": "181903576540382628",
  "administration_id": 123,
  "entity_id": "181903576201692575",
  "entity_type": "SalesInvoice",
  "user_id": 14876966215920,
  "assignee_id": 14876966215920,
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": null,
  "created_at": "2017-02-21T17:06:30.728Z",
  "updated_at": "2017-02-21T17:06:30.728Z"
}
      

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/sales_invoices/181903576725980587/notes/181903577081447856.json
    

Response

Sends an invoice

This endpoint provides two options: sending the invoice and scheduling sending in the future. When sending now, you can provide a send method, email address and message. If you don’t provide any arguments, the defaults from the contact and workflow will be used.

When scheduling sending, set the boolean sending_scheduled to true and provide an invoice_date.

Parameters

Parameter Type Description
sales_invoice_sending[delivery_method] String

Can be Email, Simplerinvoicing, Post or Manual.

sales_invoice_sending[sending_scheduled] Boolean
sales_invoice_sending[deliver_ubl] Boolean
sales_invoice_sending[mergeable] Boolean
sales_invoice_sending[email_address] String
sales_invoice_sending[email_message] String
sales_invoice_sending[invoice_date] String

Example: sends an invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903557110269049/send_invoice.json
    

Response

Example: returns error when sending invalid invoice without details

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903557580031107/send_invoice.json
    

Response

        
          Status: 400 Bad Request
          
        
      
      {
  "error": "details cannot be empty",
  "symbolic": {
    "sales_invoice": "details_cannot_be_empty"
  }
}
      

Example: returns error when sending invoice from identity without email

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903557888312459/send_invoice.json
    

Response

        
          Status: 422 Unprocessable Entity
          
        
      
      {
  "error": {
    "delivery_method": [
      "The sender address must contain an email address"
    ]
  }
}
      

Example: returns error when sending invoice to contact without email address

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903558225953940/send_invoice.json
    

Response

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

Example: sends an invoice with alternative information

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"sales_invoice_sending":{"delivery_method":"Email","email_address":"alternative@example.com","email_message":"Hi, this is my invoice with id {invoice_id}!"}}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903558575129757/send_invoice.json
    

Response

Example: schedule sending

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"sales_invoice_sending":{"sending_scheduled":true,"invoice_date":"2017-02-22"}}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903559089980583/send_invoice.json
    

Response

Register 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 in base currency. 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.

Example: registers payments

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"payment":{"payment_date":"2017-02-21 17:06:15 UTC","price":"363.0"}}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903559853343928/register_payment.json
    

Response

        
          Status: 200 OK
          
        
      
      {
  "id": "181903560229782717",
  "administration_id": 123,
  "invoice_type": "SalesInvoice",
  "invoice_id": "181903559853343928",
  "financial_account_id": null,
  "user_id": 14876966215920,
  "payment_transaction_id": null,
  "price": "363.0",
  "price_base": "363.0",
  "payment_date": "2017-02-21",
  "credit_invoice_id": null,
  "financial_mutation_id": null,
  "created_at": "2017-02-21T17:06:15.174Z",
  "updated_at": "2017-02-21T17:06:15.174Z"
}
      

Register a payment for a creditinvoice

Example: registers payments for a credit invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{}' \
  https://moneybird.com/api/v2/123/sales_invoices/181903560904017097/register_payment_creditinvoice.json
    

Response

        
          Status: 200 OK
          
        
      
      {
  "id": "181903560904017097",
  "administration_id": 123,
  "contact_id": "181903560388117697",
  "contact": {
    "id": "181903560388117697",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "created_at": "2017-02-21T17:06:15.324Z",
    "updated_at": "2017-02-21T17:06:15.324Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/c85c40ad5659374b0979deff6d5ea225d39bd405493ba9abefb1bf7e0fe8308f/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "invoice_id": "2017-0002",
  "recurring_sales_invoice_id": null,
  "workflow_id": "181903403083892150",
  "document_style_id": "181903403938481600",
  "identity_id": "181903402453697973",
  "draft_id": null,
  "state": "paid",
  "invoice_date": "2017-02-21",
  "due_date": "2017-03-07",
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van het factuurnummer {document.invoice_id}. Voor vragen kunt u contact opnemen per e-mail.",
  "reference": "Project X",
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": "181903560489829572",
  "paid_at": "2017-02-21",
  "sent_at": "2017-02-21",
  "created_at": "2017-02-21T17:06:15.816Z",
  "updated_at": "2017-02-21T17:06:16.202Z",
  "details": [
    {
      "id": "181903560910308554",
      "administration_id": 123,
      "tax_rate_id": "181903402082502063",
      "ledger_account_id": "181903401873835420",
      "amount": "",
      "description": "**Creditfactuur voor factuur 2017-0001**",
      "price": "0.0",
      "period": null,
      "row_order": 1,
      "total_price_excl_tax_with_discount": "0.0",
      "total_price_excl_tax_with_discount_base": "0.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2017-02-21T17:06:15.822Z",
      "updated_at": "2017-02-21T17:06:16.047Z"
    },
    {
      "id": "181903560916600011",
      "administration_id": 123,
      "tax_rate_id": "181903402082502063",
      "ledger_account_id": "181903401873835420",
      "amount": "-1 x",
      "description": "Project X",
      "price": "300.0",
      "period": null,
      "row_order": 2,
      "total_price_excl_tax_with_discount": "-300.0",
      "total_price_excl_tax_with_discount_base": "-300.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "created_at": "2017-02-21T17:06:15.828Z",
      "updated_at": "2017-02-21T17:06:16.051Z"
    }
  ],
  "payments": [
    {
      "id": "181903561274164430",
      "administration_id": 123,
      "invoice_type": "SalesInvoice",
      "invoice_id": "181903560904017097",
      "financial_account_id": null,
      "user_id": 14876966215920,
      "payment_transaction_id": null,
      "price": "-363.0",
      "price_base": "-363.0",
      "payment_date": "2017-02-21",
      "credit_invoice_id": null,
      "financial_mutation_id": null,
      "created_at": "2017-02-21T17:06:16.169Z",
      "updated_at": "2017-02-21T17:06:16.169Z"
    }
  ],
  "total_paid": "-363.0",
  "total_unpaid": "0.0",
  "total_unpaid_base": "0.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "-300.0",
  "total_price_excl_tax_base": "-300.0",
  "total_price_incl_tax": "-363.0",
  "total_price_incl_tax_base": "-363.0",
  "url": "http://moneybird.dev/123/sales_invoices/dafa4a04eccddab3bd015997b2e61693e129d0ddb6d10ff682bf42f1dcf73b5d/c85c40ad5659374b0979deff6d5ea225d39bd405493ba9abefb1bf7e0fe8308f",
  "custom_fields": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "credit_invoice_created_from_original",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "original_invoice": "2017-0001"
      },
      "created_at": "2017-02-21T17:06:15.839Z",
      "updated_at": "2017-02-21T17:06:15.839Z"
    },
    {
      "administration_id": 123,
      "user_id": 14876966215920,
      "action": "sales_invoice_send_email",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "email_address": "info@example.com",
        "email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2017-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 07-03-2017 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
      },
      "created_at": "2017-02-21T17:06:16.103Z",
      "updated_at": "2017-02-21T17:06:16.103Z"
    }
  ]
}
      

Sends a reminder

This endpoint sends a reminder to a contact. A reminder can contain multiple sales invoices. Reminders are grouped by workflow, identity and document style, so a contact with sales invoices with different workflows, will receive multiple reminders. Only by grouping reminders like this, we can assure the right content and layout of a reminder.

Parameters

Parameter Type Description
sales_invoice_reminders Array

Required

sales_invoice_reminders[contact_id] Integer

Required

sales_invoice_reminders[workflow_id] Integer

Required

sales_invoice_reminders[identity_id] Integer

Required

sales_invoice_reminders[document_style_id] Integer

Required

sales_invoice_reminders[sales_invoice_ids] Array

Required

sales_invoice_reminders[reminder_text] String
sales_invoice_reminders[delivery_method] String
sales_invoice_reminders[email_address] String

Example: sends reminders for given invoices

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"sales_invoice_reminders":[{"contact_id":181903562003973341,"workflow_id":181903562097296607,"document_style_id":181903403938481600,"identity_id":181903402453697973,"sales_invoice_ids":[181903562264020198]},{"contact_id":181903562003973341,"workflow_id":181903562626827498,"document_style_id":181903403938481600,"identity_id":181903402453697973,"sales_invoice_ids":[181903562801939697]},{"contact_id":181903563101832438,"workflow_id":181903562097296607,"document_style_id":181903403938481600,"identity_id":181903402453697973,"sales_invoice_ids":[181903563204592888,181903563632411900]}]}' \
  https://moneybird.com/api/v2/123/sales_invoices/send_reminders.json
    

Response

Example: returns an error when invalid parameters are given

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"sales_invoice_reminders":[{"contact_id":181903565292307727,"workflow_id":181903565383533841,"document_style_id":181903403938481600,"identity_id":181903402453697973,"sales_invoice_ids":[181903565601637656],"email_address":"invalid.email"}]}' \
  https://moneybird.com/api/v2/123/sales_invoices/send_reminders.json
    

Response

        
          Status: 422 Unprocessable Entity
          
        
      
      {
  "errors": [
    {
      "email_address": [
        "is not valid"
      ]
    }
  ]
}
      

Duplicate to credit invoice

Mark as uncollectible

This endpoint marks a sales invoice as uncollectible. If you choose credit_invoice as booking method it will return the generated credit invoice otherwise it returns the sales invoice.

Parameters

Parameter Type Description
book_method String

Required

Can be credit_invoice or expense.

Add attachment to sales invoice

Example: uploads an attachment

Request

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

Response