Moneybird logo
Moneybird API

Documents: Purchase invoices

Purchase invoices are invoices you receive from your suppliers.


List ids and versions of purchase invoices

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

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

Required scope(s)

documents

List ids and versions of purchase 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 ids and versions of purchase invoices › query Parameters

filter
​string

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

List ids and versions of purchase invoices › Responses

200

IDs and versions of records

​object[]
id
​integer | string
version
​integer | string

Fetch purchase invoices with given ids

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

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

Required scope(s)

documents

Fetch purchase 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 purchase invoices with given ids › Request Body

ids
​(integer | string)[] · required

Fetch purchase invoices with given ids › Responses

200

A list of purchase invoices

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
due_date
​string | null · date
entry_number
​integer | null
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
currency
​currency

ISO 4217 currency code

exchange_rate
​string | null
revenue_invoice
​boolean | null
prices_are_incl_tax
​boolean | null
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
paid_at
​string | null · date
tax_number
​string | null
total_price_excl_tax
​string | null
total_price_excl_tax_base
​string | null
total_price_incl_tax
​string | null
total_price_incl_tax_base
​string | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​detail_response[]
​fiscal_allocation_response[]
​payment_response[]
​note_response[]
​attachment_response[]
​event_response[]

Download attachment

GET
https://moneybird.com/api/v2
/{administration_id}/documents/purchase_invoices/{id}/attachments/{attachment_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)

documents

Download attachment › 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

attachment_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}/documents/purchase_invoices/{id}/attachments/{attachment_id}{format}

Deletes an attachment of an attachable.

Required scope(s)

documents

Delete an attachment › 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

attachment_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

Add attachment to purchase invoice

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

Add an attachment to a purchase invoice.

Required scope(s)

documents

Add attachment to purchase 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 purchase invoice › Request Body

file
​string · binary

Add attachment to purchase invoice › Responses

Status code

integer

Delete a payment

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/purchase_invoices/{id}/payments/{payment_id}{format}

Deletes a payment from a purchase invoice.

Required scope(s)

documents

Delete 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

payment_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}/documents/purchase_invoices/{id}/payments{format}

Registers a payment for a purchase invoice.

Required scope(s)

documents

Create 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

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

deprecated

Register a payment for a purchase invoice

PATCH
https://moneybird.com/api/v2
/{administration_id}/documents/purchase_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)

documents

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

Register a payment for a purchase invoice › Request Body

​object

Register a payment for a purchase invoice › Responses

Status code

integer

Get purchase invoice

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

Returns a purchase invoice by id.

Required scope(s)

documents

Get purchase 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

Get purchase invoice › Responses

A purchase invoice

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
due_date
​string | null · date
entry_number
​integer | null
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
currency
​currency

ISO 4217 currency code

exchange_rate
​string | null
revenue_invoice
​boolean | null
prices_are_incl_tax
​boolean | null
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
paid_at
​string | null · date
tax_number
​string | null
total_price_excl_tax
​string | null
total_price_excl_tax_base
​string | null
total_price_incl_tax
​string | null
total_price_incl_tax_base
​string | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​detail_response[]
​fiscal_allocation_response[]
​payment_response[]
​note_response[]
​attachment_response[]
​event_response[]

Delete a purchase invoices

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

Deletes a purchase invoice.

Required scope(s)

documents

Delete a purchase invoices › 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 purchase invoices › Responses

Status code

integer

Update purchase invoice

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

Updates a purchase invoice.

Required scope(s)

documents

Update purchase 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 purchase invoice › Request Body

​object

Update purchase invoice › Responses

Purchase invoice updated

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
due_date
​string | null · date
entry_number
​integer | null
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
currency
​currency

ISO 4217 currency code

exchange_rate
​string | null
revenue_invoice
​boolean | null
prices_are_incl_tax
​boolean | null
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
paid_at
​string | null · date
tax_number
​string | null
total_price_excl_tax
​string | null
total_price_excl_tax_base
​string | null
total_price_incl_tax
​string | null
total_price_incl_tax_base
​string | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​detail_response[]
​fiscal_allocation_response[]
​payment_response[]
​note_response[]
​attachment_response[]
​event_response[]

Destroys note from entity

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/purchase_invoices/{purchase_invoice_id}/notes/{id}{format}

Deletes a note from the purchase invoice.

Required scope(s)

documents

Destroys note from entity › path Parameters

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

The unique identifier of the administration

A unique record identifier

purchase_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}/documents/purchase_invoices/{purchase_invoice_id}/notes{format}

Adds a note to the purchase invoice.

Required scope(s)

documents

Adds note to entity › path Parameters

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

The unique identifier of the administration

A unique record identifier

purchase_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

Get purchase invoices

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

Returns a paginated list of documents of this type in the administration.

Required scope(s)

documents

Get purchase 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

Get purchase invoices › query Parameters

filter
​string

Filters are key:value terms separated by commas (e.g. period:this_year,state:open). 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
periodStringthis_yearA named period (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 range (201301..201302, 20130101..20130131)
stateStringallall, new, saved, open, paid, late or pending_payment. paid, late and pending_payment only apply to documents with a payment lifecycle (purchase invoices and receipts)
recurringStringallall, enabled or disabled
attachmentStringallall, with or without
referenceStringDocuments with the given reference value
contact_idIntegerDocuments belonging to the given contact
ledger_account_idIntegerDocuments booking against the given ledger account
updated_afterStringISO 8601 timestamp in UTC; documents updated strictly after this time

Multiple values for state, recurring and attachment can be combined with a pipe, e.g. state:open|paid.

Default: period:this_year
new_filter
​string

String terms, example: key1:value1,key2:value2.

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

Get purchase invoices › Responses

A list of purchase invoices

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
due_date
​string | null · date
entry_number
​integer | null
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
currency
​currency

ISO 4217 currency code

exchange_rate
​string | null
revenue_invoice
​boolean | null
prices_are_incl_tax
​boolean | null
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
paid_at
​string | null · date
tax_number
​string | null
total_price_excl_tax
​string | null
total_price_excl_tax_base
​string | null
total_price_incl_tax
​string | null
total_price_incl_tax_base
​string | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​detail_response[]
​fiscal_allocation_response[]
​payment_response[]
​note_response[]
​attachment_response[]
​event_response[]

Create a new purchase invoice

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

Creates a new purchase invoice.

Required scope(s)

documents

Create a new purchase 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 new purchase invoice › Request Body

​object

Create a new purchase invoice › Responses

Purchase invoice created

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
due_date
​string | null · date
entry_number
​integer | null
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
currency
​currency

ISO 4217 currency code

exchange_rate
​string | null
revenue_invoice
​boolean | null
prices_are_incl_tax
​boolean | null
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
paid_at
​string | null · date
tax_number
​string | null
total_price_excl_tax
​string | null
total_price_excl_tax_base
​string | null
total_price_incl_tax
​string | null
total_price_incl_tax_base
​string | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​detail_response[]
​fiscal_allocation_response[]
​payment_response[]
​note_response[]
​attachment_response[]
​event_response[]