Moneybird logo
Moneybird API

Sales invoices

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.

An invoice does not have an invoice_id when its a draft, so a draft is never found here. List drafts through GET /sales_invoices with state:draft and fetch one with GET /sales_invoices/{id}.

Required scope(s)

sales_invoices

Get an invoice by invoice_id › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

invoice_id
​string · required

Unique invoice identifier

format
​string · 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_id › Responses

A sales invoice

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Get an invoice by reference › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

reference
​string · required
format
​string · 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 reference › Responses

A sales invoice

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Sends a reminder › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

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

Default: .json

Sends a reminder › Request Body

​object[] · required

Sends a reminder › Responses

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.

Required scope(s)

sales_invoices

List all ids and versions › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · 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 versions › query Parameters

filter
​string

Comma-separated key:value filter terms. Same syntax as GET /sales_invoices — see that operation's description for the available keys.

List all ids and versions › Responses

IDs and versions of records

​object[]
id
​integer | string
version
​integer | 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.

Required scope(s)

sales_invoices

Fetch sales invoices with given ids › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · 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 ids › Request Body

ids
​(integer | string)[] · required

Fetch sales invoices with given ids › Responses

A list of sales invoices

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Add attachment to sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 invoice › Request Body

file
​string · binary

Add attachment to sales invoice › Responses

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.

Required scope(s)

sales_invoices

Download sales invoice packing slip PDF by id › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 id › query Parameters

media
​string

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

Download sales invoice packing slip PDF by id › Responses

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.

Required scope(s)

sales_invoices

Download sales invoice PDF by id › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 id › query Parameters

media
​string

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

Download sales invoice PDF by id › Responses

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.

Required scope(s)

sales_invoices

Download sales invoice UBL by id › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 id › Responses

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.

Required scope(s)

sales_invoices

Duplicate to credit invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 invoice › Request Body

Duplicate to credit invoice › Responses

Sales invoice updated

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Mark as dubious › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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_date
​string · date

Mark as dubious › Responses

Sales invoice updated

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Mark as uncollectible › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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_date
​string · date
book_method
​string

Can be revenue.

Mark as uncollectible › Responses

Sales invoice updated

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Pause sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

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

Default: .json

Pause sales invoice › Request Body

Pause sales invoice › Responses

Sales invoice paused

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Register a payment › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 › Request Body

​object

Register a payment › Responses

Sales invoice updated


Register a payment for a creditinvoice

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

Settles a credit invoice against the sales invoice it credits. On the settlements ledger account, one payment is booked on each invoice, so they settle against each other. Both use today as the payment date and the total amount of the credit invoice, so no request body values are needed. The invoice must be a credit invoice, it must have an original invoice, and both invoices must be in a state that accepts a payment.

Required scope(s)

sales_invoices

Register a payment for a creditinvoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 creditinvoice › Request Body

Register a payment for a creditinvoice › Responses

Sales invoice updated

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Resume sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

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

Default: .json

Resume sales invoice › Request Body

Resume sales invoice › Responses

Sales invoice resumed

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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. If you have sent the invoice before, then the settings from the previous sending are used instead of the defaults.

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

Required scope(s)

sales_invoices

Sends an invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

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

Default: .json

Sends an invoice › Request Body

​object

Sends an invoice › Responses

Sales invoice updated

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Get an invoice by id › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 id › Responses

A sales invoice

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Delete a sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 invoice › Responses

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.

Required scope(s)

sales_invoices

Update a sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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 invoice › Request Body

​object

Update a sales invoice › Responses

Sales invoice updated

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Download attachment › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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}/sales_invoices/{sales_invoice_id}/attachments/{id}{format}

Deletes an attachment of an attachable.

Required scope(s)

sales_invoices

Delete an attachment › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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}/sales_invoices/{sales_invoice_id}/notes/{id}{format}

Deletes a note from the sales invoice.

Required scope(s)

sales_invoices

Destroys note from entity › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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}/sales_invoices/{sales_invoice_id}/notes{format}

Adds a note to the sales invoice.

Required scope(s)

sales_invoices

Adds note to entity › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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

​object

Adds note to entity › Responses

Note created

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

entity_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

entity_type
​string
user_id
​identifier · pattern: ^\d+$

A unique record identifier

assignee_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

todo
​boolean | string | null
Default: false
note
​string | null
completed_at
​string | null · date-time
completed_by_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

todo_type
​string | 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
data
​object | null
created_at
​timestamp · date-time
updated_at
​timestamp · 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.

Required scope(s)

sales_invoices

Delete a payment › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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}/sales_invoices/{sales_invoice_id}/payments{format}

Registers a payment for a sales invoice.

Required scope(s)

sales_invoices

Create a payment › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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

​object

Create a payment › Responses

Payment created

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

invoice_type
​string · enum
Enum values:
SalesInvoice
Document
ExternalSalesInvoice
VatDocument
invoice_id
​identifier · pattern: ^\d+$

A unique record identifier

financial_account_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

user_id
​identifier · pattern: ^\d+$

A unique record identifier

payment_transaction_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

transaction_identifier
​string | null
​number
​number
payment_date
​string · date
credit_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

financial_mutation_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

ledger_account_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

linked_payment_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

manual_payment_action
​string | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time

List all invoices

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

Returns a paginated list of sales invoices in the administration.

Required scope(s)

sales_invoices

List all invoices › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

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

Default: .json

List all invoices › query Parameters

filter
​string

Filters are key:value terms separated by commas (e.g. period:this_year,state:all). Any filter you pass replaces the defaults below entirely, so include every key you need — in particular pass an explicit period (a named period or a YYYYMMDD..YYYYMMDD range) to look beyond the default financial year. Available filters:

FilterTypeDefaultDescription
stateStringallall, draft, open, scheduled, pending_payment, late, reminded, paid or uncollectible
periodStringthis_yearA period description (this_week, prev_week, next_week, 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 by separating the values with a pipe (state:draft|scheduled). This also holds for the reference.

A draft with no invoice_date set is only matched by a period when that period contains today. To list drafts irrespective of date, pass state:draft without a period; to narrow them down in time, use created_after or updated_after.

Default: period:this_year
page
​integer | string
per_page
​integer | string · min: 1 · max: 100 · pattern: ^\d+$

List all invoices › Responses

A list of sales invoices

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]

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.

Required scope(s)

sales_invoices

Create a sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · 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 invoice › Request Body

​object
from_payment_request
​boolean | string

Set to true when the invoice was created from a Moneybird payment request.

Create a sales invoice › Responses

Sales invoice created

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
invoice_id
​string | null

The invoice number. It is null while the invoice is a draft.

recurring_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

subscription_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

document_style_id
​identifier · pattern: ^\d+$

A unique record identifier

identity_id
​identifier · pattern: ^\d+$

A unique record identifier

draft_id
​integer | null

Sequence number a draft is referred to by while it has no invoice number yet.

state
​string · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_date
​string | null · date
due_date
​string · date
payment_conditions
​string | null
payment_reference
​string | null
short_payment_reference
​string | null
reference
​string | null
language
​string | null
currency
​string
discount
​string | null
original_sales_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

paused
​boolean
paid_at
​string | null · date
sent_at
​string | null · date
created_at
​string · date-time
updated_at
​string · date-time
public_view_code
​string | null
public_view_code_expires_at
​string | null · date-time
version
​version
​detail_response[]
​payment_response[]
total_paid
​string
total_unpaid
​string
total_unpaid_base
​string
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
total_discount
​string
marked_dubious_on
​string | null · date
marked_uncollectible_on
​string | null · date
reminder_count
​integer | null
next_reminder
​string | null · date
original_estimate_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

url
​string
payment_url
​string
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​tax_subtotal_response[]
​minimal_time_entry_response[]