TL02 - List transaction lines

Products

TL02 - List transaction lines

Request

Description

This resource uses seek pagination. The maximum allowed value for parameter limit is 2000.

Call Frequency

Recommended usage: 20 times per day

Maximum usage: 20 times per min, 60 times per hour

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)
lastUpdated - Sort by last updated date (Recommended) (desc by default)

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ACCOUNTANCY)

Query

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.

date_created_fromstring, (date-time)

Creation date

date_created_tostring, (date-time)

Creation date

transaction_date_fromstring, (date-time)

Transaction date

transaction_date_tostring, (date-time)

Transaction date

last_updated_fromstring, (date-time)

Last updated date

payment_stateArray of strings, [ 0 .. 100 ] items

Payment state. This parameter can be supplied multiple times.

Items Enum:"PENDING""PAYABLE""PAID""NOT_APPLICABLE""RESERVE"

transaction_typeArray of strings, [ 0 .. 100 ] items

Transaction type. This parameter can be supplied multiple times.

Items Enum:"MANUAL_CREDIT""MANUAL_CREDIT_VAT""MANUAL_INVOICE""MANUAL_INVOICE_VAT""INVOICEABLE_ONE_OFF_DEBIT""INVOICEABLE_ONE_OFF_DEBIT_TAX""INVOICEABLE_ONE_OFF_CREDIT""INVOICEABLE_ONE_OFF_CREDIT_TAX""INVOICEABLE_MIRAKL_ADS_DEBIT""INVOICEABLE_MIRAKL_ADS_DEBIT_TAX"

accounting_document_numberstring

Accounting document number

order_idArray of strings, [ 0 .. 100 ] items

Order id. This parameter can be supplied multiple times.

order_line_idArray of strings, [ 0 .. 100 ] items

Order line id. This parameter can be supplied multiple times.

order_reference_for_customerArray of strings, [ 0 .. 100 ] items

A comma-separated list of order references for customer.

order_reference_for_sellerArray of strings, [ 0 .. 100 ] items

A comma-separated list of order references for seller.

accounting_document_idstring

Accounting document request id. This parameter filters on documents requests with these entity types: SHOP_BILLING_CYCLE_PURCHASE_ORDER, FEES or ONE_OFF_FEES.

shop_modelArray of strings

Shop model. This parameter can be supplied multiple times.

Items Enum:"MARKETPLACE""DROPSHIP""ONE_CREDITOR"

pay_out_psp_codesArray of strings

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

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

other_referenceArray of strings, [ 0 .. 100 ] items

An external reference for one-off transactions that are not tied to a Mirakl order. This parameter can be supplied multiple times.

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/sellerpayment/transactions_logs?seller_billing_cycle_id=stringstringstringstringstringstring&date_created_from=2019-08-24T14%3A15%3A22Z&date_created_to=2019-08-24T14%3A15%3A22Z&transaction_date_from=2019-08-24T14%3A15%3A22Z&transaction_date_to=2019-08-24T14%3A15%3A22Z&last_updated_from=2019-08-24T14%3A15%3A22Z&payment_state=PENDING&transaction_type=MANUAL_CREDIT&accounting_document_number=string&order_id=string&order_line_id=string&order_reference_for_customer=string&order_reference_for_seller=string&accounting_document_id=string&shop_model=MARKETPLACE&pay_out_psp_codes=NOT_SPECIFIED&other_reference=string&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

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": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}