Skip to content
Products
/
Mirakl Platform
/
/Invoicing and Accounting

DR11 - List accounting documents requests

Request

Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

  • dateCreated (Default) - Sort by creation date (desc by default)

Security
Operator-Bearer-Token or OAuth-2
Query
idstring

Filter by accounting document request identifier.

document_numberstring

Filter by accounting document number.

date_created_fromstring, (date-time)

Filter accounting document requests created after the given date.

date_created_tostring, (date-time)

Filter accounting document requests created before the given date.

last_updated_fromstring, (date-time)

Filter accounting document requests updated after the given date.

last_updated_tostring, (date-time)

Filter accounting document requests updated before the given date.

issue_date_fromstring, (date-time)

Filter accounting document requests issued after the given date.

issue_date_tostring, (date-time)

Filter accounting document requests issued before the given date.

stateArray of strings, [ 0 .. 100 ] items

Filter by accounting document request state. This parameter can be supplied multiple times.

Items Enum:"STAGING""TO_PROCESS""ISSUED""CANCELED"
typeArray of strings, [ 0 .. 100 ] items

Filter by accounting document request type. This parameter can be supplied multiple times.

Items Enum:"INVOICE""CREDIT_NOTE"
issuer_typeArray of strings, [ 0 .. 100 ] items

Filter by accounting document request issuer type. This parameter can be supplied multiple times.

Items Enum:"OPERATOR""SHOP"
shop_idsArray of integers, (int64), [ 0 .. 100 ] items

Filter by the shop identifier linked to the accounting document request entity. This parameter can be supplied multiple times.

entity_idArray of strings, [ 0 .. 100 ] items

Filter by accounting document request entity identifier. This parameter can be supplied multiple times.

The entity_type must be specified to use this filter, otherwise an error 400 will be returned.

Example: entity_id=order1-A&entity_id=order20-A&entity_type=PRODUCT_LOGISTIC_ORDER

entity_typeArray of strings, [ 0 .. 100 ] items

Filter by accounting document request entity type. This parameter can be supplied multiple times.

Items Enum:"PRODUCT_LOGISTIC_ORDER""SHOP_BILLING_CYCLE_PURCHASE_ORDER""LOGISTIC_PURCHASE_ORDER""FEES""ONE_OFF_FEES"
shop_billing_cycle_idstring

Filter accounting document requests generated by a shop billing cycle having the given identifier.

This filter is only available for document requests of the type: FEES, ONE_OFF_FEES, SHOP_BILLING_CYCLE_PURCHASE_ORDER.

shop_billing_cycle_fromstring, (date-time)

Filter accounting document requests generated by shop billing cycle after the given date.

This filter is only available for document requests of the type: FEES, ONE_OFF_FEES, SHOP_BILLING_CYCLE_PURCHASE_ORDER.

This parameter was previously named billing_cycle_from, which is still accepted but deprecated.

shop_billing_cycle_tostring, (date-time)

Filter accounting document requests generated by shop billing cycle before the given date.

This filter is only available for document requests of the type: FEES, ONE_OFF_FEES, SHOP_BILLING_CYCLE_PURCHASE_ORDER.

This parameter was previously named billing_cycle_to, which is still accepted but deprecated.

payment_statestring

Filter by accounting document request payment state.

This filter is only available for document requests of the type: SHOP_BILLING_CYCLE_PURCHASE_ORDER, LOGISTIC_PURCHASE_ORDER, FEES.

Enum:"PAID""PENDING"
curl -i -X GET \
  'https://your-instance.mirakl.net/api/document-request/requests?id=string&document_number=string&date_created_from=2019-08-24T14%3A15%3A22Z&date_created_to=2019-08-24T14%3A15%3A22Z&last_updated_from=2019-08-24T14%3A15%3A22Z&last_updated_to=2019-08-24T14%3A15%3A22Z&issue_date_from=2019-08-24T14%3A15%3A22Z&issue_date_to=2019-08-24T14%3A15%3A22Z&state=STAGING&type=INVOICE&issuer_type=OPERATOR&shop_ids=0&entity_id=string&entity_type=PRODUCT_LOGISTIC_ORDER&shop_billing_cycle_id=string&shop_billing_cycle_from=2019-08-24T14%3A15%3A22Z&shop_billing_cycle_to=2019-08-24T14%3A15%3A22Z&payment_state=PAID' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response
{
  "data": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}