Moneybird logo
Moneybird API

Sales invoices

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

Sales invoices are the invoices you send to your customers for products or services you have delivered.


Get an invoice by invoice_id

GET
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/find_by_invoice_id/{invoice_id}{format}

Get a sales invoice by the invoice_id field of the sales invoice.

Get an invoice by invoice_idpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • invoice_idstring · required

    Unique invoice 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 invoice by invoice_idResponses

A 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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Get an invoice by reference

GET
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/find_by_reference/{reference}{format}

Get a sales invoice by the reference field of the sales invoice.

Get an invoice by referencepath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • referencestring · required
  • 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 invoice by referenceResponses

A 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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Sends a reminder

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

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.

Sends a reminderpath 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

Sends a reminderRequest Body

  • sales_invoice_remindersobject[] · required

Sends a reminderResponses

Status code

integer

List all ids and versions

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

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.

List all ids and versionspath 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 ids and versionsquery Parameters

  • filterstring

List all ids and versionsResponses

IDs and versions of records

  • idinteger | string
  • versioninteger | string

Fetch sales invoices with given ids

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

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.

Fetch sales invoices with given idspath 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

Fetch sales invoices with given idsRequest Body

  • ids(integer | string)[] · required

Fetch sales invoices with given idsResponses

A list of 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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Add attachment to sales invoice

POST
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{id}/attachments{format}

Add an attachment to a sales invoice.

Add attachment to sales invoicepath 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 sales invoiceRequest Body

  • filestring · binary

Add attachment to sales invoiceResponses

Status code

integer

Download sales invoice packing slip PDF by id

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

Redirects to the download URL of the sales invoice as packing slip PDF. The link is valid for 30 seconds.

Download sales invoice packing slip PDF by idpath 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

Download sales invoice packing slip PDF by idquery Parameters

  • mediastring

    In case you want to hide sender address and logo you can set this to 'stationery'.

Download sales invoice packing slip PDF by idResponses

Found

string

Download sales invoice PDF by id

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

Redirects to the download URL of the sales invoice as PDF. The link is valid for 30 seconds.

Download sales invoice PDF by idpath 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

Download sales invoice PDF by idquery Parameters

  • mediastring

    In case you want to hide sender address and logo you can set this to 'stationery'.

Download sales invoice PDF by idResponses

Found

string

Download sales invoice UBL by id

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

Download the sales invoice as UBL.

Download sales invoice UBL by idpath 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

Download sales invoice UBL by idResponses

A sales invoice

string

Duplicate to credit invoice

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

Duplicate a sales invoice to a new credit invoice.

Duplicate to credit invoicepath 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

Duplicate to credit invoiceRequest Body

Duplicate to credit invoiceResponses

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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Mark as dubious

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

This endpoint marks a sales invoice as dubious.

Mark as dubiouspath 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 dubiousRequest Body

  • dubious_datestring · date

Mark as dubiousResponses

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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Mark as uncollectible

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

This endpoint marks a sales invoice as uncollectible.

Mark as uncollectiblepath 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 uncollectibleRequest Body

  • uncollectible_datestring · date
  • book_methodstring

    Can be revenue.

Mark as uncollectibleResponses

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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Pause sales invoice

POST
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{id}/pause{format}

This endpoint pauses a sales invoice. The automatic workflow steps will not be executed while the sales invoice is paused.

Pause sales invoicepath 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

Pause sales invoiceRequest Body

Pause sales invoiceResponses

Sales invoice paused

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

deprecated

Register a payment

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

This endpoint is deprecated and should no longer be used. It has been replaced by Create a payment.

Register a paymentpath 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

Register a paymentRequest Body

  • paymentobject

Register a paymentResponses

Sales invoice updated

Additional properties are allowed

Register a payment for a creditinvoice

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

Register a payment for a creditinvoice. Requires that the invoice is a credit invoice.

Register a payment for a creditinvoicepath 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

Register a payment for a creditinvoiceRequest Body

Register a payment for a creditinvoiceResponses

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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Resume sales invoice

POST
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{id}/resume{format}

This endpoint resumes the sales invoice. The automatic workflow steps will execute again after resuming.

Resume sales invoicepath 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

Resume sales invoiceRequest Body

Resume sales invoiceResponses

Sales invoice resumed

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Sends an invoice

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

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.

Sends an invoicepath 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

Sends an invoiceRequest Body

  • sales_invoice_sendingobject

Sends an invoiceResponses

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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Get an invoice by id

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

Returns a sales invoices in the administration.

Note that the link in the url attribute will only work if viewing invoices online has been enabled and the invoice is not a draft.

Get an invoice by idpath 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 invoice by idResponses

A 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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Delete a sales invoice

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

Delete a sales invoice. Requires that the sales invoice has no pending payments and is not in a locked bookkeeping period.

Delete a sales invoicepath 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 a sales invoiceResponses

Sales invoice deleted

No data returned

Update a sales invoice

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

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

Update a sales invoicepath 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 a sales invoiceRequest Body

  • sales_invoiceobject

Update a sales invoiceResponses

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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Download attachment

GET
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{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 attachmentpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • 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 attachmentResponses

Found

string

Delete an attachment

DELETE
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{sales_invoice_id}/attachments/{id}{format}

Deletes an attachment of an attachable.

Delete an attachmentpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • 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 attachmentResponses

Attachment deleted

No data returned

Destroys note from entity

DELETE
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{sales_invoice_id}/notes/{id}{format}

Deletes a note from the sales invoice.

Destroys note from entitypath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • 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 entityResponses

Note deleted

No data returned

Adds note to entity

POST
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{sales_invoice_id}/notes{format}

Adds a note to the sales invoice.

Adds note to entitypath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • 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 entityRequest Body

  • noteobject

Adds note to entityResponses

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}/sales_invoices/{sales_invoice_id}/payments/{id}{format}

Delete a payment from a sales invoice.

Delete a paymentpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • 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 paymentResponses

Payment deleted

No data returned

Create a payment

POST
https://moneybird.com/api/v2
/{administration_id}/sales_invoices/{sales_invoice_id}/payments{format}

Registers a payment for a sales invoice.

Create a paymentpath Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • 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 paymentRequest Body

  • paymentobject

Create a paymentResponses

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

List all invoices

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

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:

FilterTypeDefaultDescription
stateStringallall, draft, open, scheduled, pending_payment, late, reminded, paid or uncollectible
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)
referenceStringSelect invoices with a certain reference
contact_idIntegerSelect invoices belonging to a certain contact
recurring_sales_invoice_idIntegerSelect invoices created by a certain recurring invoice
workflow_idIntegerSelect invoices that use a certain workflow
created_afterStringSelect invoices created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone
updated_afterStringSelect invoices updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone

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. This also holds for the reference.

List all invoicespath 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 invoicesquery Parameters

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

List all invoicesResponses

A list of 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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]

Create a sales invoice

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

Create a sales invoice with the parameters defined in the request body.

Create a sales invoicepath 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 a sales invoiceRequest Body

  • sales_invoiceobject
  • from_payment_requestboolean | string

Create a sales invoiceResponses

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 · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • contact_person
  • invoice_idstring | null
  • recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

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

    A unique record identifier

  • draft_idinteger | null
  • statestring · enum
    Enum values:
    draft
    scheduled
    open
    pending_payment
    reminded
    late
    paid
    uncollectible
  • invoice_datestring | null · date
  • due_datestring · date
  • payment_conditionsstring | null
  • payment_referencestring | null
  • short_payment_referencestring | null
  • referencestring | null
  • languagestring | null
  • currencystring
  • discountstring | null
  • original_sales_invoice_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • pausedboolean
  • paid_atstring | null · date
  • sent_atstring | null · date
  • created_atstring · date-time
  • updated_atstring · date-time
  • public_view_codestring | null
  • public_view_code_expires_atstring | null · 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
  • total_discountstring
  • marked_dubious_onstring | null · date
  • marked_uncollectible_onstring | null · date
  • reminder_countinteger | null
  • next_reminderstring | null · date
  • original_estimate_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • urlstring
  • payment_urlstring
  • custom_fieldsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
  • tax_totalsobject[]
  • time_entriesobject[]