IV01 - List accounting documents

Request

Description

⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, IV01 will contain no new data. Use the SBC11 and DR11 APIs instead.

Call Frequency

Recommended usage: Once per day and as many times as there are invoice pages returned

Maximum usage: Once per day and as many times as there are invoice pages returned

Pagination

This resource supports offset pagination (see documentation)

Sort fields

sort field can have the following values:

dateCreated (Default) - Sort by creation date (asc by default)

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)

Query

currencystring

Currency code for filtering

Enum:"AED""ARS""AUD""BAM""BGN""BHD""BRL""CAD""CHF""CLP"

end_datestring, (date-time)

Creation date for filtering

invoice_idArray of integers, (int64), <= 100 items

Invoice IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.

issuing_user_typesArray of strings, unique

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

Items Enum:"OPERATOR""BATCH""PARTNER"

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.

Items Enum:"NOT_SPECIFIED""MANGOPAY""MIRAKL_PAYOUT""OPERATOR"

payment_statusstring

Accounting document payment state

Enum:"PENDING""PAID""FAILED"

seller_billing_cycle_idArray of strings, <= 100 items

Seller billing cycle IDs for filtering. This parameter can be supplied multiple times or be a comma-separated list.

start_datestring, (date-time)

Creation date for filtering

typestring

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

Default:"AUTO_INVOICE"

Enum:"ALL""AUTO_INVOICE""MANUAL_INVOICE""MANUAL_CREDIT"

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/invoices?currency=AED&end_date=2019-08-24T14%3A15%3A22Z&invoice_id=0&issuing_user_types=OPERATOR&pay_out_psp_codes=NOT_SPECIFIED&payment_status=PENDING&seller_billing_cycle_id=stringstringstringstringstringstring&start_date=2019-08-24T14%3A15%3A22Z&type=ALL&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

invoicesArray of objects

Accounting documents

total_countinteger, (int64)

Accounting documents total count

Response

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