Mirakl Platform for Services APIs (latest-release)

Servers

URL to be replaced by your Mirakl instance URL

https://your-instance.mirakl.net/

Platform Settings

Operations

Invoicing and Accounting

Operations

List accounting documents

Request

Query

currencystring

Currency code for filtering

end_datestring(date-time)

Creation date for filtering

issuing_user_typesArray of strings

A comma separated list of issuing user type for filtering. By default all types are returned

pay_out_psp_codesArray of strings

A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.

payment_statusstring

Accounting document payment state

payment_voucher_numberstring

Payment voucher for filtering

shopinteger(int64)

Shop identifier for filtering

shop_modelArray of strings

A comma separated list of shop model for filtering

shop_operator_internal_idstring

Operator internal id of the shop for filtering

start_datestring(date-time)

Creation date for filtering

statesArray of strings

A comma separated list of state of the accounting document for filtering

Default ["GENERATED","COMPLETE"]

typestring

Accounting document type for filtering. By default only invoices by the shop payment process are returned.

Default "AUTO_INVOICE"

maxinteger(int32)

Maximum number of items returned per page

offsetinteger(int32)

Index of the first item (among all the results) in the returned page

sortstring

How the results should be sorted

orderstring

Sort direction

curl -i -X GET \
  'https://your-instance.mirakl.net/api/invoices?currency=string&end_date=2019-08-24T14%3A15%3A22Z&issuing_user_types=string&max=0&offset=0&order=string&pay_out_psp_codes=string&payment_status=string&payment_voucher_number=string&shop=0&shop_model=string&shop_operator_internal_id=string&sort=string&start_date=2019-08-24T14%3A15%3A22Z&states=GENERATED%2CCOMPLETE&type=AUTO_INVOICE'

Responses

Bodyapplication/json

invoicesArray of objects(IV01_Response_200_Invoices)

Accounting documents

total_countinteger(int64)

Accounting documents total count

Response

application/json

{
  "invoices": [
    { … }
  ],
  "total_count": 0
}

Stores

Operations

Services

Operations

Orders

Operations