Moneybird API

Recurring sales invoices

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

Recurring sales invoices are templates for invoices that are sent automatically at a recurring interval.

List all IDs and versions

GET

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/synchronization{format}

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

List all IDs and versions › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

List all IDs and versions › query Parameters

filterstring

List all IDs and versions › Responses

IDs and versions of records

idinteger | string
versioninteger | string

Fetch recurring sales invoices with given IDs

POST

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/synchronization{format}

Given a list of recurring sales invoice IDs, returns the details of the recurring invoices. Returns a maximum of 100 recurring invoices, even if more IDs are provided.

Fetch recurring sales invoices with given IDs › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Fetch recurring sales invoices with given IDs › Request Body

ids(integer | string)[] · required

Fetch recurring sales invoices with given IDs › Responses

A list of recurring 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
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
start_datestring · date
invoice_datestring · date
last_datestring | null · date
activeboolean | null
payment_conditionsstring | null
referencestring | null
languagestring
currencystring
discountstring | null
first_due_intervalinteger
auto_sendboolean | null
sending_scheduled_atstring | null · date-time
sending_scheduled_user_idstring | integer | null · pattern: ^\d+$
A unique record identifier
frequency_typestring · enum
Enum values:
day
week
month
quarter
year
frequencyinteger
created_atstring | null · date-time
updated_atstring | null · date-time
versioninteger
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
detailsobject[]
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
subscription

Get a recurring sales invoice by id

GET

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{id}{format}

Get a recurring sales invoice by id.

Get a recurring sales invoice by id › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Get a recurring sales invoice by id › Responses

A recurring 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
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
start_datestring · date
invoice_datestring · date
last_datestring | null · date
activeboolean | null
payment_conditionsstring | null
referencestring | null
languagestring
currencystring
discountstring | null
first_due_intervalinteger
auto_sendboolean | null
sending_scheduled_atstring | null · date-time
sending_scheduled_user_idstring | integer | null · pattern: ^\d+$
A unique record identifier
frequency_typestring · enum
Enum values:
day
week
month
quarter
year
frequencyinteger
created_atstring | null · date-time
updated_atstring | null · date-time
versioninteger
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
detailsobject[]
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
subscription

Destroy or deactivate a recurring sales invoice

DELETE

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{id}{format}

A recurring sales invoice will be destroyed if it has not created any sales invoices. If it has created sales invoices, it will be deactivated.

Destroy or deactivate a recurring sales invoice › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Destroy or deactivate a recurring sales invoice › Responses

Recurring sales invoice deleted

No data returned

Updates a recurring sales invoice

PATCH

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{id}{format}

Updates a recurring sales invoice. Only possible if the recurring sales invoice has no active subscription.

Updates a recurring sales invoice › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Updates a recurring sales invoice › Request Body

recurring_sales_invoiceobject

Updates a recurring sales invoice › Responses

Recurring 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
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
start_datestring · date
invoice_datestring · date
last_datestring | null · date
activeboolean | null
payment_conditionsstring | null
referencestring | null
languagestring
currencystring
discountstring | null
first_due_intervalinteger
auto_sendboolean | null
sending_scheduled_atstring | null · date-time
sending_scheduled_user_idstring | integer | null · pattern: ^\d+$
A unique record identifier
frequency_typestring · enum
Enum values:
day
week
month
quarter
year
frequencyinteger
created_atstring | null · date-time
updated_atstring | null · date-time
versioninteger
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
detailsobject[]
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
subscription

Destroys note from entity

DELETE

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes/{id}{format}

Deletes a note from the recurring sales invoice.

Destroys note from entity › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
recurring_sales_invoice_idstring | integer · pattern: ^\d+$ · required
A unique record identifier
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Destroys note from entity › Responses

Note deleted

No data returned

Adds note to entity

POST

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes{format}

Adds a note to the recurring sales invoice.

Adds note to entity › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
recurring_sales_invoice_idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Adds note to entity › Request Body

noteobject

Adds note to entity › Responses

Note created

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
entity_idstring | integer | null · pattern: ^\d+$
A unique record identifier
entity_typestring
user_idstring | integer · pattern: ^\d+$
A unique record identifier
assignee_idstring | integer | null · pattern: ^\d+$
A unique record identifier
todoboolean | string | null
Default: false
notestring | null
completed_atstring | null · date-time
completed_by_idstring | integer | null · pattern: ^\d+$
A unique record identifier
todo_typestring | null · enum
Enum values:
sales_invoice_due
purchase_invoice_due
general_document_reminder
general_document_due
new_document_awaiting_processing
new_financial_mutation_awaiting_processing
financial_mutations_not_updated
sales_invoice_payment_not_linked_to_financial_mutation
dataobject | null
created_atstring · date-time
updated_atstring · date-time

List all recurring sales invoices

GET

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices{format}

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

The filter argument allows you to filter on the list of recurring invoices. Filters are a combination of keys and values, separated by a comma: state:active,contact_id:123. The available options for filtering are:

Filter	Type	Default	Description
state	`String`	`active`	`active` or `inactive`
frequency	`String`	`all`	`all`, `day`, `week`, `month`, `quarter` or `year`
auto_send	`Boolean`	`null`	`null`, `true` or `false`
contact_id	`Integer`		Filters recurring invoices by a single contact
workflow_id	`Integer`		Filters recurring invoices by a single workflow

List all recurring sales invoices › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

List all recurring sales invoices › query Parameters

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

List all recurring sales invoices › Responses

A list of recurring 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
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
start_datestring · date
invoice_datestring · date
last_datestring | null · date
activeboolean | null
payment_conditionsstring | null
referencestring | null
languagestring
currencystring
discountstring | null
first_due_intervalinteger
auto_sendboolean | null
sending_scheduled_atstring | null · date-time
sending_scheduled_user_idstring | integer | null · pattern: ^\d+$
A unique record identifier
frequency_typestring · enum
Enum values:
day
week
month
quarter
year
frequencyinteger
created_atstring | null · date-time
updated_atstring | null · date-time
versioninteger
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
detailsobject[]
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
subscription

Creates a new recurring sales invoice

POST

https://moneybird.com/api/v2

/{administration_id}/recurring_sales_invoices{format}

A recurring sales invoice will create new sales invoices on set intervals. To create a new recurring sales invoice, you need to provide at least a contact and details for the invoice. Furthermore you need to determine the planning. The following fields will influence the planning:

invoice_date: the date in which the first invoice should be created
frequency_type: the type of frequency you want to use, for example month
frequency: defines the actual frequency, e.g. frequency=2 and frequency_type=month will create an invoice every 2 months
has_desired_count: whether or not the desired count should take effect
desired_count: maximum number of sales invoices to create

Creates a new recurring sales invoice › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Creates a new recurring sales invoice › Request Body

recurring_sales_invoiceobject

Creates a new recurring sales invoice › Responses

Recurring 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
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
start_datestring · date
invoice_datestring · date
last_datestring | null · date
activeboolean | null
payment_conditionsstring | null
referencestring | null
languagestring
currencystring
discountstring | null
first_due_intervalinteger
auto_sendboolean | null
sending_scheduled_atstring | null · date-time
sending_scheduled_user_idstring | integer | null · pattern: ^\d+$
A unique record identifier
frequency_typestring · enum
Enum values:
day
week
month
quarter
year
frequencyinteger
created_atstring | null · date-time
updated_atstring | null · date-time
versioninteger
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
detailsobject[]
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
subscription

Purchase transactions Sales invoices