How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mirakl Invoicing and Accounting API

The Invoicing and Accounting API from Mirakl — 11 operation(s) for invoicing and accounting.

Mirakl Invoicing and Accounting API is one of 34 APIs that Mirakl publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invoicing and Accounting. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 11 paths, and defines 132 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://your-instance.mirakl.net.

11 operations 11 paths 132 schemas 9 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://your-instance.mirakl.net
Authentication
HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 8

Mirakl Invoicing and Accounting API declares 8 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token). It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token). It accepts HTTP bearer tokens (JWT) (operator_bearer_token). An API key is passed in the header as Authorization (Shop-API-Key). An API key is passed in the header as Authorization (shop_api_key). An API key is passed in the header as Authorization (front_api_key). An API key is passed in the header as Authorization (operator_api_key).

  • OAuth-2 — For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 9 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Invoicing and Accounting 11
GET
/api/document-request/documents/download
DR73 - Download accounting documents
DR73 5 params → 200
GET
/api/invoices
IV01 - List accounting documents
IV01 14 params → 200
GET
/api/seller-billing-cycles
SBC11 - List seller billing cycles
SBC11 8 params → 200
GET
/api/document-request/requests
DR11 - List accounting documents requests
DR11 18 params → 200
GET
/api/document-request/{document_request_id}/lines
DR12 - List lines of a document request
DR12 1 param → 200
POST
/api/document-request/documents/upload
DR74 - Upload accounting documents
DR74 body → 200
GET
/api/invoices/{accounting_document_id}
IV02 - Download an accounting document
IV02 1 param → 200
GET
/api/sellerpayment/transactions_logs
TL02 - List transaction lines
TL02 18 params → 200
POST
/api/sellerpayment/transactions_logs/async
TL03 - Export transaction lines JSON file asynchronously
TL03 1 param body → 200
GET
/api/sellerpayment/transactions_logs/async/status/{tracking_id}
TL04 - Poll the status of an asynchronous transaction log export (TL03)
TL04 2 params → 200
GET
/dynamic-url/The+URL+is+retrieved+from+TL04+output/TL05
TL05 - Retrieve transaction logs files once asynchronous transaction logs export is complete (TL04)
TL05 3 params → 200

Schemas 132

The contract defines 132 schemas that model the data the API accepts and returns. The most detailed are SBC11_Response_200_Data_Summary (44 properties), SBC11_Response_200_Data_Summary_3 (40 properties), SBC11_Response_200_Data_Summary_4 (40 properties), SBC11_Response_200_Data_Summary_2 (40 properties). Each schema is shown below with its type and property counts.

SBC11_Response_200_Data_Shop
object
5 properties
IV01_Response_200_Invoices_Payment
object
4 properties
IV01_Response_200_Invoices_IssuingUser
object
2 properties
SBC11_Response_200
object
3 properties 1 required
SBC11_Response_200_Data
object
10 properties
IV01_Response_200_Invoices_Details
object
6 properties
IV01_Response_200_Invoices_Details_Taxes
object
2 properties
SBC11_Response_200_Data_PayOut
object
4 properties
SBC11_Response_200_Data_Summary
object
44 properties
IV01_Response_200
object
2 properties
IV01_Response_200_Invoices
object
24 properties
IV01_Response_200_Invoices_TotalTaxes
object
2 properties
IV01_Response_200_Invoices_ShopAddress
object
13 properties
DR12_Response_200_Data_ShippingFrom
object
1 property
DR11_Response_200_Data_Recipient
object
6 properties 2 required
DR11_Response_200_Data_Recipient_Organization
object
17 properties 1 required
DR12_Response_200_Data_Order
object
6 properties 1 required
DR12_Response_200_Data_FeesExcludingTaxes
object
3 properties 3 required
DR12_Response_200_Data_Order_TransactionInfo
object
2 properties 2 required
DR74_Response_200_Requests_Input_Files
object
2 properties 2 required
DR74_Request_MultipartFormData_DocumentsInput_Requests_Files
object
The files details for each required format
2 properties 2 required
DR74_Request_MultipartFormData_DocumentsInput_Requests
object
The details of the files to be uploaded
7 properties 3 required
DR12_Response_200_Data_ShippingTo
object
1 property
DR74_Response_200_Requests
object
2 properties 1 required
DR12_Response_200_Data_OrderLine
object
1 property 1 required
DR11_Response_200_Data
object
26 properties 16 required
DR11_Response_200_Data_Issuer
object
4 properties 2 required
DR11_Response_200_Data_Issuer_Organization_PersonalInformation
object
3 properties
DR11_Response_200_Data_Recipient_BillingAddress
object
12 properties 4 required
DR12_Response_200_Data_ShippingTaxes
object
3 properties 2 required
DR74_Request_MultipartFormData_DocumentsInput
object
1 property 1 required
DR11_Response_200_Data_Entities_ShopBillingCycle
object
3 properties
DR12_Response_200_Data_Shop
object
1 property 1 required
DR11_Response_200_Data_PaymentTerms
object
2 properties
DR74_Response_200_Requests_Input
object
7 properties 3 required
DR74_Response_200_Requests_Errors
object
3 properties 3 required
DR12_Response_200_Data_ShippingFrom_Address
object
6 properties 1 required
DR11_Response_200_Data_PaymentDestination
object
2 properties 1 required
DR11_Response_200_Data_Issuer_Organization_Address
object
6 properties 3 required
DR12_Response_200_Data_Taxes
object
3 properties 2 required
DR11_Response_200_Data_Issuer_Organization
object
19 properties 1 required
DR11_Response_200_Data_Issuer_Organization_FiscalRepresentative
object
12 properties 8 required
DR11_Response_200_Data_Entities_ShippingInformation_ShipToAddress
object
13 properties
DR11_Response_200_Data_Payment
object
3 properties
DR12_Response_200
object
3 properties 1 required
DR11_Response_200
object
3 properties 1 required
DR11_Response_200_Data_Recipient_ShippingAddress
object
12 properties 4 required
DR12_Response_200_Data_EcoContributions
object
5 properties
SBC11_Response_200_Data_Summary_2
object
40 properties
DR11_Response_200_Data_Recipient_Organization_Address
object
6 properties 3 required
DR11_Response_200_Data_Entities_DeliveryBillInformation
object
2 properties
DR74_Response_200
object
1 property 1 required
DR11_Response_200_Data_Entities_ShippingInformation
object
1 property
DR12_Response_200_Data
object
22 properties 9 required
DR11_Response_200_Data_InitialDocuments
object
4 properties 3 required
DR12_Response_200_Data_ShippingTo_Address
object
13 properties
DR12_Response_200_Data_DeliveryBillInformation
object
2 properties
DR12_Response_200_Data_Product
object
3 properties 2 required
DR11_Response_200_Data_Entities
object
4 properties
DR11_Response_200_Data_Taxes
object
3 properties 2 required
DR11_Response_200_Data_DocumentDetails
object
1 property 1 required
DR12_Response_200_Data_Product_References
object
2 properties 2 required
TL05_Response_200_Ext_FileStructure_Entities_Order
object
5 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderTax
object
2 properties
TL04_Response_200_Error
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_Refund
object
1 property
TL02_Response_200_Data_Entities_Order
object
5 properties
TL05_Response_200_Ext_FileStructure
object
17 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OneOffItem
object
5 properties
TL05_Response_200_Ext_FileStructure_Entities_Fee
object
3 properties
TL02_Response_200_Data_Entities_Debit
object
1 property
TL02_Response_200_Data_Entities_OrderFee
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure
object
17 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_ManualAccountingDocument
object
2 properties
TL02_Response_200_Data_Entities_Channel
object
1 property
TL03_Request
object
23 properties
TL02_Response_200_Data_Entities_Fee_Cancelations
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee_Cancelations
object
1 property
TL02_Response_200_Data_Entities_OneOffItem_References
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_Shipment
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_ShopTax
object
2 properties
TL02_Response_200_Data_Entities_Order_PaymentInfo
object
2 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Order_PaymentInfo
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_Fee_Refunds
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_TransactionInfo
object
2 properties
TL02_Response_200_Data_Entities_Shipment
object
1 property
TL02_Response_200
object
3 properties 1 required
SBC11_Response_200_Data_Summary_3
object
40 properties
TL05_Response_200_Ext_FileStructure_Entities_Debit
object
1 property
TL02_Response_200_Data_Entities_Refund
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Order
object
5 properties
TL02_Response_200_Data
object
17 properties
TL02_Response_200_Data_Entities_OneOffItem
object
5 properties
TL05_Response_200_Ext_FileStructure_Entities_OneOffItem
object
5 properties
TL02_Response_200_Data_Entities
object
14 properties
TL05_Response_200_Ext_FileStructure_Entities_OrderLine
object
1 property
TL02_Response_200_Data_Entities_ManualAccountingDocument
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_ManualAccountingDocument
object
2 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Order_References
object
2 properties
TL02_Response_200_Data_Entities_Fee_Refunds
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Shipment
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderLine
object
1 property
TL02_Response_200_Data_Entities_TransactionInfo
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_TransactionInfo
object
2 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OneOffItem_References
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_OrderTax
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_Fee_Cancelations
object
1 property
TL05_Response_200_Ext_FileStructure_Entities_Channel
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Debit
object
1 property
TL05_Response_200_Ext_FileStructure_Entities_Order_References
object
2 properties
TL03_Response_200
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Refund
object
1 property
TL02_Response_200_Data_Entities_Order_References
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_Order_PaymentInfo
object
2 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_OrderFee
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee
object
3 properties
TL05_Response_200_Ext_FileStructure_Entities_ShopTax
object
2 properties
TL02_Response_200_Data_Entities_OrderTax
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities
object
14 properties
TL02_Response_200_Data_Entities_ShopTax
object
2 properties
TL05_Response_200_Ext_FileStructure_Entities_OrderFee
object
1 property
IV01_Response_200_Invoices_2
object
23 properties
TL02_Response_200_Data_Entities_OrderLine
object
1 property
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities
object
14 properties
TL02_Response_200_Data_Entities_Fee
object
3 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Channel
object
1 property
TL04_Response_200
object
4 properties
TL05_Response_200_Ext_FileStructure_Entities_OneOffItem_References
object
2 properties
TL05_Response_200_ApplicationXNdjson_Ext_FileStructure_Entities_Fee_Refunds
object
1 property
SBC11_Response_200_Data_Summary_4
object
40 properties
SBC11_Response_200_Data_Summary_5
object
40 properties
IV01_Response_200_Invoices_3
object
23 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-invoicing-and-accounting-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
Mirakl Catalog Configuration API
Mirakl Incidents API
Mirakl Messages API
Mirakl Multiple shipments API
Mirakl Offers API
Mirakl Orders API
Mirakl Picklists API
Mirakl Platform Settings API
Mirakl Product Feedback API
Mirakl Products API
Mirakl Promotions API
Where this information came from

This is an independent, third-party profile of Mirakl Invoicing and Accounting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.