Moneybird logo
Moneybird API

External sales invoices

Endpoint:https://moneybird.com/api/v2

External sales invoices are invoices created in other systems that you want to import into Moneybird for a complete overview of your revenue.

Create external sales invoice from attachment

POST
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/attachment{format}

Creates an external sales invoice from an attachment.

Create external sales invoice from attachment › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Create external sales invoice from attachment › Request Body

  • filestring · binary

Create external sales invoice from attachment › Responses

Status code

integer

Download attachment

GET
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/attachments/{id}/download{format}

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

Download attachment › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • external_sales_invoice_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Download attachment › Responses

Found

string

Delete an attachment

DELETE
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/attachments/{id}{format}

Deletes an attachment of an attachable.

Delete an attachment › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • external_sales_invoice_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Delete an attachment › Responses

Attachment deleted

No data returned

Destroys note from entity

DELETE
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/notes/{id}{format}

Deletes a note from the external sales invoice

Destroys note from entity › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • external_sales_invoice_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Destroys note from entity › Responses

Note deleted

No data returned

Adds note to entity

POST
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/notes{format}

Adds a note to the external sales invoice.

Adds note to entity › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • external_sales_invoice_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Adds note to entity › Request Body

  • noteobject

Adds note to entity › Responses

Note created

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • entity_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • entity_typestring
  • user_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • assignee_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • todoboolean | string | null
    Default: false
  • notestring | null
  • completed_atstring | null · date-time
  • completed_by_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • todo_typestring | null · enum
    Enum values:
    sales_invoice_due
    purchase_invoice_due
    general_document_reminder
    general_document_due
    new_document_awaiting_processing
    new_financial_mutation_awaiting_processing
    financial_mutations_not_updated
    sales_invoice_payment_not_linked_to_financial_mutation
  • dataobject | null
  • created_atstring · date-time
  • updated_atstring · date-time

Delete a payment

DELETE
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/payments/{id}{format}

Deletes a payment from an external sales invoice.

Delete a payment › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • external_sales_invoice_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Delete a payment › Responses

Payment deleted

No data returned

Create a payment

POST
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{external_sales_invoice_id}/payments{format}

Registers a payment for a external sales invoice.

Create a payment › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • external_sales_invoice_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Create a payment › Request Body

  • paymentobject

Create a payment › Responses

Payment created

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • invoice_typestring · enum
    Enum values:
    SalesInvoice
    Document
    ExternalSalesInvoice
    VatDocument
  • invoice_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • financial_account_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • user_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • payment_transaction_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • transaction_identifierstring | null
  • price
  • price_base
  • payment_datestring · date
  • credit_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • financial_mutation_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • ledger_account_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • linked_payment_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • manual_payment_actionstring | null
  • created_atstring · date-time
  • updated_atstring · date-time

Add attachment to external sales invoice

POST
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{id}/attachment{format}

Add an attachment to an external sales invoice.

Add attachment to external sales invoice › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Add attachment to external sales invoice › Request Body

  • filestring · binary

Add attachment to external sales invoice › Responses

Status code

integer

Mark as dubious

PATCH
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{id}/mark_as_dubious{format}

This endpoint marks an external sales invoice as dubious.

Mark as dubious › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Mark as dubious › Request Body

  • dubious_datestring · date

Mark as dubious › Responses

External sales invoice updated

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    uncollectible
    pending_payment
  • due_datestring | null · date
  • referencestring | null
  • entry_numberinteger
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • sourcestring | null
  • source_urlstring | null
  • currencystring

    ISO 4217 currency code

  • paid_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • total_paidstring
  • total_unpaidstring
  • total_unpaid_basestring
  • prices_are_incl_taxboolean
  • total_price_excl_taxstring
  • total_price_excl_tax_basestring
  • total_price_incl_taxstring
  • total_price_incl_tax_basestring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]

Mark as uncollectible

PATCH
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{id}/mark_as_uncollectible{format}

This endpoint marks an external sales invoice as uncollectible.

Mark as uncollectible › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Mark as uncollectible › Request Body

  • uncollectible_datestring · date
  • book_methodstring

    Can be revenue.

Mark as uncollectible › Responses

External sales invoice updated

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    uncollectible
    pending_payment
  • due_datestring | null · date
  • referencestring | null
  • entry_numberinteger
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • sourcestring | null
  • source_urlstring | null
  • currencystring

    ISO 4217 currency code

  • paid_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • total_paidstring
  • total_unpaidstring
  • total_unpaid_basestring
  • prices_are_incl_taxboolean
  • total_price_excl_taxstring
  • total_price_excl_tax_basestring
  • total_price_incl_taxstring
  • total_price_incl_tax_basestring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]

Get an external sales invoice by id

GET
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{id}{format}

Returns an external sales invoices in the administration.

Get an external sales invoice by id › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Get an external sales invoice by id › Responses

A external sales invoice

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    uncollectible
    pending_payment
  • due_datestring | null · date
  • referencestring | null
  • entry_numberinteger
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • sourcestring | null
  • source_urlstring | null
  • currencystring

    ISO 4217 currency code

  • paid_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • total_paidstring
  • total_unpaidstring
  • total_unpaid_basestring
  • prices_are_incl_taxboolean
  • total_price_excl_taxstring
  • total_price_excl_tax_basestring
  • total_price_incl_taxstring
  • total_price_incl_tax_basestring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]

Delete an external sales invoice

DELETE
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{id}{format}

Deletes an external sales invoice.

Delete an external sales invoice › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Delete an external sales invoice › Responses

External sales invoice deleted

No data returned

Update an external sales invoice

PATCH
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices/{id}{format}

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

Update an external sales invoice › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Update an external sales invoice › Request Body

  • external_sales_invoiceobject

Update an external sales invoice › Responses

External sales invoice updated

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    uncollectible
    pending_payment
  • due_datestring | null · date
  • referencestring | null
  • entry_numberinteger
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • sourcestring | null
  • source_urlstring | null
  • currencystring

    ISO 4217 currency code

  • paid_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • total_paidstring
  • total_unpaidstring
  • total_unpaid_basestring
  • prices_are_incl_taxboolean
  • total_price_excl_taxstring
  • total_price_excl_tax_basestring
  • total_price_incl_taxstring
  • total_price_incl_tax_basestring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]

List all external invoices

GET
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices{format}

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

The filter argument allows you to filter the list of external invoices. Filters are a combination of keys and values, separated by a comma: period:this_year,state:all. The available options for filtering are:

FilterTypeDefaultDescription
stateStringallall, new, open, late, or paid
periodStringthis_yearThis 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_idIntegerSelect invoices belonging to a certain contact

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

List all external invoices › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

List all external invoices › query Parameters

  • filterstring
  • per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

List all external invoices › Responses

A list of external sales invoices

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    uncollectible
    pending_payment
  • due_datestring | null · date
  • referencestring | null
  • entry_numberinteger
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • sourcestring | null
  • source_urlstring | null
  • currencystring

    ISO 4217 currency code

  • paid_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • total_paidstring
  • total_unpaidstring
  • total_unpaid_basestring
  • prices_are_incl_taxboolean
  • total_price_excl_taxstring
  • total_price_excl_tax_basestring
  • total_price_incl_taxstring
  • total_price_incl_tax_basestring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]

Create an external sales invoice

POST
https://moneybird.com/api/v2
/{administration_id}/external_sales_invoices{format}

Creates a new external sales invoice.

Create an external sales invoice › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Create an external sales invoice › Request Body

  • external_sales_invoiceobject

Create an external sales invoice › Responses

External sales invoice created

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    uncollectible
    pending_payment
  • due_datestring | null · date
  • referencestring | null
  • entry_numberinteger
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • sourcestring | null
  • source_urlstring | null
  • currencystring

    ISO 4217 currency code

  • paid_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • total_paidstring
  • total_unpaidstring
  • total_unpaid_basestring
  • prices_are_incl_taxboolean
  • total_price_excl_taxstring
  • total_price_excl_tax_basestring
  • total_price_incl_taxstring
  • total_price_incl_tax_basestring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
EstimatesFinancial accounts