Mirakl Invoicing and Accounting API
The Invoicing and Accounting API from Mirakl — 11 operation(s) for invoicing and accounting.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mirakl-invoicing-and-accounting-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Mirakl Invoicing and Accounting API
version: ''
description: 'Operations tagged Invoicing and Accounting across 6 of this provider''s published API definitions: mirakl-mmp-front-openapi.yaml, mirakl-mmp-operator-openapi.json, mirakl-mmp-seller-openapi.json, mirakl-mms-front-openapi.yaml, mirakl-mms-operator-openapi.json, mirakl-mms-seller-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: URL to be replaced by your Mirakl instance URL
url: https://your-instance.mirakl.net
tags:
- name: Invoicing and Accounting
paths:
/api/document-request/documents/download:
get:
description: '<div class="extension-title">Description</div>
At least one of the following filters must be applied: <code>document_id</code> or <code>entity_id</code><br>If more than one document is requested, the output of the API will be a ZIP archive.<br>The tree structure of this archive is as follows:<pre>
documents-1624624030618.zip
|
|__ product-logistic-order/
| |__order1-A/| |__ INV203837.pdf
| |__ INV203837.cxml
| |__order1-B/| |__ INV203839.pdf
</pre>
<div class="api-description-extension">
</div>'
operationId: DR73
parameters:
- description: The document request unique identifier. This parameter can be supplied multiple times.
explode: true
in: query
name: document_request_id
required: false
schema:
type: array
items:
type: string
maxItems: 100
minItems: 0
style: form
- description: Document identifiers. This parameter can be supplied multiple times.
explode: true
in: query
name: document_id
required: false
schema:
type: array
items:
type: string
maxItems: 100
minItems: 0
style: form
- description: Document formats. This parameter can be supplied multiple times.
explode: true
in: query
name: document_format
required: false
schema:
type: array
items:
type: string
enum:
- PDF
- cXML
maxItems: 100
minItems: 0
style: form
- description: 'Entity identifiers related to the documents to download. This parameter can be supplied multiple times.<br>The <code>entity_type</code> must be specified to use this filter, otherwise an error 400 will be returned.<br>Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER'
explode: true
in: query
name: entity_id
required: false
schema:
type: array
items:
type: string
maxItems: 100
minItems: 0
style: form
- description: Entity types related to the documents to download. This parameter can be supplied multiple times.
explode: true
in: query
name: entity_type
required: false
schema:
type: array
items:
type: string
enum:
- PRODUCT_LOGISTIC_ORDER
- SHOP_BILLING_CYCLE_PURCHASE_ORDER
- LOGISTIC_PURCHASE_ORDER
- FEES
- ONE_OFF_FEES
maxItems: 100
minItems: 0
style: form
responses:
'200':
content:
application/octet-stream:
examples:
application/octet-stream-auto:
summary: Complete example with value types (application/octet-stream)
value: string
schema:
type: string
format: binary
description: OK
security:
- Front-Bearer-Token: []
- OAuth-2: []
summary: DR73 - Download accounting documents
tags:
- Invoicing and Accounting
servers:
- description: URL to be replaced by your Mirakl instance URL
url: https://your-instance.mirakl.net
/api/invoices:
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day and as many times as there are invoice pages returned</div>
<div class="max-call-frequency">Maximum usage: Once per day and as many times as there are invoice pages returned</div>
<div class="extension-title">Pagination</div>
<p>This resource supports offset pagination (<a href="#section/Offset-pagination-and-sort">see documentation</a>)</p>
<div class="extension-title">Sort fields</div>
<code>sort</code> field can have the following values:<ul><li><b>dateCreated</b> (Default) - Sort by creation date (asc by default)</li></ul>
</div>'
operationId: IV01
parameters:
- description: Currency code for filtering
explode: true
in: query
name: currency
required: false
schema:
type: string
enum:
- AED
- ARS
- AUD
- BAM
- BGN
- BHD
- BRL
- CAD
- CHF
- CLP
- CNY
- COP
- CZK
- DKK
- EGP
- EUR
- GBP
- GEL
- GTQ
- HKD
- HRK
- HUF
- IDR
- ILS
- INR
- IQD
- JOD
- JPY
- KES
- KRW
- KWD
- LKR
- MAD
- MGA
- MXN
- MYR
- NGN
- NOK
- NZD
- OMR
- PEN
- PHP
- PKR
- PLN
- QAR
- RON
- RSD
- RUB
- SAR
- SEK
- SGD
- TND
- TRY
- THB
- TWD
- UAH
- USD
- UYU
- UZS
- VND
- ZAR
style: form
- description: Creation date for filtering
explode: true
in: query
name: end_date
required: false
schema:
type: string
format: date-time
style: form
- description: Invoice IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.
explode: true
in: query
name: invoice_id
required: false
schema:
type: array
items:
type: integer
format: int64
maxItems: 100
style: form
- description: A comma separated list of issuing user type for filtering. By default all types are returned
explode: true
in: query
name: issuing_user_types
required: false
schema:
type: array
items:
type: string
enum:
- OPERATOR
- BATCH
- PARTNER
uniqueItems: true
style: form
- description: A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.
explode: true
in: query
name: pay_out_psp_codes
required: false
schema:
type: array
items:
type: string
enum:
- NOT_SPECIFIED
- MANGOPAY
- MIRAKL_PAYOUT
- OPERATOR
style: form
- description: Accounting document payment state
explode: true
in: query
name: payment_status
required: false
schema:
type: string
enum:
- PENDING
- PAID
- FAILED
style: form
- description: Payment voucher for filtering
explode: true
in: query
name: payment_voucher_number
required: false
schema:
type: string
style: form
- description: Seller billing cycle IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.
explode: true
in: query
name: seller_billing_cycle_id
required: false
schema:
type: array
items:
type: string
maxLength: 36
minLength: 36
maxItems: 100
style: form
- description: Shop identifier for filtering
explode: true
in: query
name: shop
required: false
schema:
type: integer
format: int64
style: form
- description: A comma separated list of shop model for filtering
explode: true
in: query
name: shop_model
required: false
schema:
type: array
items:
type: string
enum:
- MARKETPLACE
- DROPSHIP
- ONE_CREDITOR
uniqueItems: true
style: form
- description: Operator internal id of the shop for filtering
explode: true
in: query
name: shop_operator_internal_id
required: false
schema:
type: string
style: form
- description: Creation date for filtering
explode: true
in: query
name: start_date
required: false
schema:
type: string
format: date-time
style: form
- description: A comma separated list of state of the accounting document for filtering
explode: true
in: query
name: states
required: false
schema:
type: array
default:
- GENERATED
- COMPLETE
items:
type: string
default: GENERATED,COMPLETE
enum:
- DRAFT
- GENERATED
- COMPLETE
uniqueItems: true
style: form
- description: Accounting document type for filtering. By default only invoices by the shop payment process are returned.
explode: true
in: query
name: type
required: false
schema:
type: string
default: AUTO_INVOICE
enum:
- ALL
- AUTO_INVOICE
- MANUAL_INVOICE
- MANUAL_CREDIT
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
invoices:
- currency_iso_code: EUR
date_created: '2018-10-02T15:45:30Z'
details:
- amount_excl_taxes: -3
description: Commissions of completed orders from 02/09/2018 to 02/11/2018
quantity: 1
taxes:
- amount: -4
code: TAX2
- amount: -3
code: TAX3
- amount_excl_taxes: 2
description: Commissions of completed orders from 02/09/2018 to 02/11/2018
quantity: 1
taxes:
- amount: 3
code: TAX1
- amount: 4
code: TAX2
- amount_excl_taxes: 3
description: Detailed accounting document item 2
quantity: 1
taxes:
- amount: 4
code: TAX2
- amount: 3
code: TAX3
- amount_excl_taxes: 3
description: Seller fees on orders from 02/09/2018 to 02/11/2018
quantity: 1
taxes:
- amount: 4
code: TAX2
- amount: 3
code: TAX3
due_date: '2026-08-12T13:09:53Z'
end_time: '2018-11-02T15:45:30Z'
id: 4cd57d45-dabd-41a9-a472-2ee052c2aa06
invoice_id: 2
issue_date: '2026-08-12T13:09:53Z'
issuing_user:
information: Automatic action
type: BATCH
pay_out_psp_code: NOT_SPECIFIED
payment:
reference: null
state: PENDING
transaction_date: null
payment_info:
'@type': IBAN
bank_city: paris
bank_name: lcl
bank_street: '12'
bank_zip: '75008'
bic: Bic
iban: Iban
owner: owner
payment_voucher_number: '123456'
seller_billing_cycle_id: f212a4b3-b2fe-4df9-aae9-7e644ff23f5f
shop_address:
city: Neuilly
civility: Mr
company: Mirakl
complementary: Pas très loin d'ici
country: FRANCE
firstname: Camille
lastname: Dumoulin
phone: 01 72 31 62 00
phone_secondary: 0687326711
state: IDF
street1: rue de la paix
street2: RDC G /s cours
zip_code: '75100'
shop_corporate_name: Ceasar Shop
shop_id: 1
shop_model: MARKETPLACE
shop_name: The Shop
shop_operator_internal_id: op1234
shop_tax_number: TAX93248
start_time: '2018-09-02T15:45:30Z'
state: COMPLETE
summary:
amount_transferred: 0
amount_transferred_to_operator: 17
total_commissions_excl_tax: -2
total_commissions_incl_tax: -9
total_fee_excl_tax: 0
total_fee_incl_tax: 0
total_fee_operator_remitted_excl_tax: 0
total_fee_operator_remitted_incl_tax: 0
total_mirakl_ads_credit_excl_tax: 0
total_mirakl_ads_credit_incl_tax: 0
total_mirakl_ads_debit_excl_tax: 0
total_mirakl_ads_debit_incl_tax: 0
total_non_payable_orders_excl_tax: 0
total_non_payable_orders_incl_tax: 0
total_operator_paid_shipping_charges_excl_tax: 0
total_operator_paid_shipping_charges_incl_tax: 0
total_operator_remitted_taxes: 0
total_other_credits_excl_tax: 0
total_other_credits_incl_tax: 0
total_other_invoices_excl_tax: 0
total_other_invoices_incl_tax: 0
total_payable_orders_excl_tax: 0
total_payable_orders_incl_tax: 0
total_purchase_taxes: 0
total_refund_commissions_excl_tax: 3
total_refund_commissions_incl_tax: 10
total_refund_fee_excl_tax: 0
total_refund_fee_incl_tax: 0
total_refund_fee_operator_remitted_excl_tax: 0
total_refund_fee_operator_remitted_incl_tax: 0
total_refund_non_payable_orders_excl_tax: 0
total_refund_non_payable_orders_incl_tax: 0
total_refund_operator_paid_shipping_charges_excl_tax: 0
total_refund_operator_paid_shipping_charges_incl_tax: 0
total_refund_operator_remitted_taxes: 0
total_refund_orders_excl_tax: 0
total_refund_orders_incl_tax: 0
total_refund_payable_orders_excl_tax: 0
total_refund_payable_orders_incl_tax: 0
total_refund_purchase_taxes: 0
total_seller_fees_on_orders_excl_tax: -5
total_seller_fees_on_orders_incl_tax: -8
total_seller_penalty_fees_excl_tax: 0
total_seller_penalty_fees_incl_tax: 0
total_subscription_excl_tax: -3
total_subscription_incl_tax: -10
total_amount_excl_taxes: 981
total_amount_incl_taxes: 1002
total_charged_amount: 1002
total_taxes:
- amount: 3
code: TAX1
- amount: 4
code: TAX2
- amount: 4
code: TAX2
- amount: 3
code: TAX3
type: AUTO_INVOICE
- currency_iso_code: EUR
date_created: '2018-10-06T15:45:30Z'
details:
- amount_excl_taxes: 1
description: Detailed accounting document item 1
operation_date: '2017-10-06T15:45:30Z'
quantity: 7
taxes:
- amount: 3
code: TAX1
- amount: 4
code: TAX2
- amount_excl_taxes: 3
description: Detailed accounting document item 2
operation_date: '2017-10-06T15:45:30Z'
quantity: 6
taxes:
- amount: 3
code: TAX3
- amount: 4
code: TAX4
due_date: '2026-08-12T13:09:53Z'
id: 84ba3367-51f5-4bb5-9535-9254b7595ed3
invoice_id: 6
issue_date: '2026-08-12T13:09:53Z'
issuing_user:
information: testuser@mirakl.com
type: PARTNER
pay_out_psp_code: NOT_SPECIFIED
payment:
reference: null
state: PENDING
transaction_date: null
payment_voucher_number: '123456'
seller_billing_cycle_id: 57061ac1-946d-4107-b6c7-f02f5642da3f
shop_address:
city: Neuilly
civility: Mr
company: Mirakl
complementary: Pas très loin d'ici
country: FRANCE
firstname: Camille
lastname: Dumoulin
phone: 01 72 31 62 00
phone_secondary: 0687326711
state: IDF
street1: rue de la paix
street2: RDC G /s cours
zip_code: '75100'
shop_corporate_name: Ceasar Shop
shop_id: 2
shop_model: MARKETPLACE
shop_name: The Shop
shop_operator_internal_id: op1234
shop_tax_number: TAX93248
state: COMPLETE
total_amount_excl_taxes: 980
total_amount_incl_taxes: 1006
total_charged_amount: 1006
total_taxes:
- amount: 3
code: TAX1
- amount: 4
code: TAX2
- amount: 3
code: TAX3
- amount: 4
code: TAX4
type: MANUAL_INVOICE
- currency_iso_code: EUR
date_created: '2018-10-06T15:45:30Z'
details:
- amount_excl_taxes: 3
description: Detailed accounting document item 3
operation_date: '2017-10-06T15:45:30Z'
quantity: 1
taxes:
- amount: 3
code: TAX3
- amount: 4
code: TAX4
id: 8da2cde0-38dc-4427-a1de-a6250ca37b8b
invoice_id: 7
issuing_user:
information: testuser@mirakl.com
type: PARTNER
pay_out_psp_code: NOT_SPECIFIED
payment:
failure_reason: INCOMPLETE_KYC
reference: null
state: FAILED
transaction_date: null
seller_billing_cycle_id: 57061ac1-946d-4107-b6c7-f02f5642da3f
shop_address:
city: Neuilly
civility: Mr
company: Mirakl
complementary: Pas très loin d'ici
country: FRANCE
firstname: Camille
lastname: Dumoulin
phone: 01 72 31 62 00
phone_secondary: 0687326711
state: IDF
street1: rue de la paix
street2: RDC G /s cours
zip_code: '75100'
shop_corporate_name: Ceasar Shop
shop_id: 2
shop_model: MARKETPLACE
shop_name: The Shop
shop_operator_internal_id: op1234
shop_tax_number: TAX93248
state: COMPLETE
total_amount_excl_taxes: 980
total_amount_incl_taxes: 1006
total_charged_amount: 1006
total_taxes:
- amount: 3
code: TAX3
- amount: 4
code: TAX4
type: MANUAL_INVOICE
total_count: 3
application/json-auto:
summary: Complete example with value types (application/json)
value:
invoices:
- currency_iso_code: AED
date_created: '2023-03-28T09:34:42Z'
details:
- amount_excl_taxes: 0
description: string
operation_date: '2023-03-28T09:34:42Z'
order_id: string
quantity: 0
taxes:
- amount: 0
code: string
due_date: '2023-03-28T09:34:42Z'
id: string
invoice_id: 0
issue_date: '2023-03-28T09:34:42Z'
issuing_user:
information: string
type: OPERATOR
pay_out_psp_code: NOT_SPECIFIED
payment:
failure_reason: INCOMPLETE_KYC
reference: string
state: PENDING
transaction_date: '2023-03-28T09:34:42Z'
payment_voucher_number: string
shop_address:
city: string
civility: string
company: string
complementary: string
country: string
firstname: string
lastname: string
phone: string
phone_secondary: string
state: string
street1: string
street2: string
zip_code: string
shop_corporate_name: string
shop_id: 0
shop_model: MARKETPLACE
shop_name: string
shop_operator_internal_id: string
shop_tax_number: string
state: string
total_amount_excl_taxes: 0
total_amount_incl_taxes: 0
total_charged_amount: 0
total_taxes:
- amount: 0
code: string
type: ALL
total_count: 0
schema:
type: object
$ref: '#/components/schemas/IV01_Response_200'
description: OK
security:
- Front-Bearer-Token: []
- OAuth-2: []
summary: IV01 - List accounting documents
tags:
- Invoicing and Accounting
servers:
- description: URL to be replaced by your Mirakl instance URL
url: https://your-instance.mirakl.net
/api/seller-billing-cycles:
get:
description: '<div class="extension-title">Description</div>
This resource uses seek pagination. The maximum allowed value for parameter <code>limit</code> is <code>1000</code>.
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: Once per day and as many times as there are billing cycle pages returned</div>
<div class="max-call-frequency">Maximum usage: Once per day and as many times as there are billing cycle pages returned</div>
<div class="extension-title">Pagination</div>
<p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p>
<div class="extension-title">Sort fields</div>
<code>sort</code> field can have the following values:<ul><li><b>dateCreated</b> (Default) - Sort by creation date (asc by default)</li></ul>
</div>'
operationId: SBC11
parameters:
- description: Currency for filtering. This parameter can be supplied multiple times.
explode: true
in: query
name: currency
required: false
schema:
type: array
items:
type: string
enum:
- AED
- ARS
- AUD
- BAM
- BGN
- BHD
- BRL
- CAD
- CHF
- CLP
- CNY
- COP
- CZK
- DKK
- EGP
- EUR
- GBP
- GEL
- GTQ
- HKD
- HRK
- HUF
- IDR
- ILS
- INR
- IQD
- JOD
- JPY
- KES
- KRW
- KWD
- LKR
- MAD
- MGA
- MXN
- MYR
- NGN
- NOK
- NZD
- OMR
- PEN
- PHP
- PKR
- PLN
- QAR
- RON
- RSD
- RUB
- SAR
- SEK
- SGD
- TND
- TRY
- THB
- TWD
- UAH
- USD
- UYU
- UZS
- VND
- ZAR
style: form
- description: Creation date used as the maximum value for filtering (inclusive)
explode: true
in: query
name: end_date
required: false
schema:
type: string
format: date-time
style: form
- description: Seller billing cycle IDs for filtering. This parameter can be supplied multiple times.
explode: true
in: query
name: id
required: false
schema:
type: array
items:
type: string
maxLength: 36
minLength: 36
maxItems: 100
style: form
- description: A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.
explode: true
in: query
name: pay_out_psp_code
required: false
schema:
type: array
items:
type: string
enum:
- NOT_SPECIFIED
- MANGOPAY
- MIRAKL_PAYOUT
- OPERATOR
style: form
- description: Pay-out state for filtering. This parameter can be supplied multiple times.
explode: true
in: query
name: pay_out_state
required: false
schema:
type: array
default:
- TO_PAY
- FAILED
- PAID
items:
type: string
default: TO_PAY,FAILED,PAID
enum:
- TO_PAY
- PAID
- FAILED
style: form
- description: Payment voucher numbers for filtering. This parameter can be supplied multiple times.
explode: true
in: query
name: payment_voucher_number
required: false
schema:
type: array
items:
type: string
style: form
- description: Shop ID for filtering. This parameter can be supplied multiple times. Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
explode: true
in: query
name: shop_id
required: false
schema:
type: array
items:
type: integer
format: int64
style: form
- description: Creation date used as the minimum value for filtering (inclusive)
explode: true
in: query
name: start_date
required: false
schema:
type: string
format: date-time
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
data:
- amount_transferred_to_operator: 1046.59
amount_transferred_to_seller: 4545.2
currency_iso_code: EUR
date_created: '2014-01-01T00:00:00Z'
id: a5b77ee5-f5c2-4efc-ab94-8366ee781598
pay_out:
reference: bank-ref
state: PAID
pay_out_psp_code: MANGOPAY
shop:
shop_corporate_name: Ceasar Shop
shop_id: 12
shop_name: The Shop
shop_operator_internal_id: op1234
summary:
total_commissions_excl_tax: -474.1
total_commissions_incl_tax: -889.24
total_fee_excl_tax: 5
total_fee_incl_tax: 5
total_fee_operator_remitted_excl_tax: -5
total_fee_operator_remitted_incl_tax: -5
total_mirakl_ads_credit_excl_tax: 0
total_mirakl_ads_credit_incl_tax: 0
total_mirakl_ads_debit_excl_tax: 0
total_mirakl_ads_debit_incl_tax: 0
total_non
# --- truncated at 32 KB (361 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-invoicing-and-accounting-api-openapi.yml