Skip to content
Products
/
/
/
TL05 - Retrieve transacti...

TL05 - Retrieve transaction logs files once asynchronous transaction logs export is complete (TL04)

Request

Description

Retrieve each chunk of an transaction logs export file via the URL generated once the asynchronous transaction logs export is complete

Security
Shop-API-Key(Required scopes: ROLE_SHOP_ACCOUNTANCY
ROLE_PARTNER_TRANSACTION_LOG_REA...
)
Path
tracking_idstringrequired

The asynchronous transaction log export id

Query
filestringrequired

The asynchronous transaction log export chunk file

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/dynamic-url/The+URL+is+retrieved+from+TL04+output/TL05?file=string&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Body
accounting_document_creation_datestring, (date-time)

The related accounting document creation date.

This field is only available when the referenced accounting document is an automatic invoice or a manual document.

accounting_document_idstring

The related accounting document id.

This field is only available when the referenced accounting document is a seller or purchase document request.

accounting_document_numberstring

The related accounting document number.

This field is only available when the referenced accounting document is:

  • an automatic invoice or a manual document,
  • an issued seller or purchase document request.
amountnumber, (with decimals)

The amount.

amount_creditednumber, (with decimals)

The amount credited.

amount_debitednumber, (with decimals)

The amount debited.

balancenumber, (with decimals)

The balance of the transaction.

currency_iso_codestring

The currency of the shop (iso format)

date_createdstring, (date-time)

Creation date of the transaction line

entitiesobject

Node containing additional information depending on type of the transaction and the domain.

idstring

Identifier of the transaction

last_updatedstring, (date-time)

Date of last update of the transaction line

pay_out_psp_codestring

Pay-out PSP code associated with the transaction.

Enum: "NOT_SPECIFIED", "MANGOPAY", "MIRAKL_PAYOUT", "OPERATOR"

payment_statestring

The payment state of the transaction.

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

psp_balancenumber, (with decimals)

The Pay-out balance of the transaction.

seller_billing_cycle_idstring

The Seller Billing Cycle ID associated with the transaction.

typestring

Type of transaction (refund, transaction fee, etc ...)

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", "INVOICEABLE_MIRAKL_ADS_CREDIT", "INVOICEABLE_MIRAKL_ADS_CREDIT_TAX", "ORDER_AMOUNT", "ORDER_AMOUNT_TAX", "ORDER_SHIPPING_AMOUNT", "ORDER_SHIPPING_AMOUNT_TAX", "COMMISSION_FEE", "COMMISSION_VAT", "REFUND_ORDER_AMOUNT", "REFUND_ORDER_AMOUNT_TAX", "REFUND_ORDER_SHIPPING_AMOUNT", "REFUND_ORDER_SHIPPING_AMOUNT_TAX", "REFUND_COMMISSION_FEE", "REFUND_COMMISSION_VAT", "SUBSCRIPTION_FEE", "SUBSCRIPTION_VAT", "OPERATOR_REMITTED_ORDER_AMOUNT_TAX", "OPERATOR_REMITTED_ORDER_SHIPPING_AMOUNT_TAX", "OPERATOR_REMITTED_REFUND_ORDER_AMOUNT_TAX", "OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX", "OPERATOR_PAID_ORDER_SHIPPING_AMOUNT", "OPERATOR_PAID_ORDER_SHIPPING_AMOUNT_TAX", "OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT", "OPERATOR_PAID_REFUND_ORDER_SHIPPING_AMOUNT_TAX", "PAYMENT", "PURCHASE_COMMISSION_FEE", "PURCHASE_SHIPPING_COMMISSION_FEE", "PURCHASE_ORDER_AMOUNT_TAX", "PURCHASE_ORDER_SHIPPING_AMOUNT_TAX", "REFUND_PURCHASE_COMMISSION_FEE", "REFUND_PURCHASE_SHIPPING_COMMISSION_FEE", "REFUND_PURCHASE_ORDER_AMOUNT_TAX", "REFUND_PURCHASE_ORDER_SHIPPING_AMOUNT_TAX", "ORDER_FEE_AMOUNT", "OPERATOR_REMITTED_ORDER_FEE_AMOUNT", "REFUND_ORDER_FEE_AMOUNT", "OPERATOR_REMITTED_REFUND_ORDER_FEE_AMOUNT", "PURCHASE_FEE_COMMISSION_FEE", "REFUND_PURCHASE_FEE_COMMISSION_FEE", "RESERVE_FUNDING", "RESERVE_SETTLEMENT", "SELLER_FEE_ON_ORDER", "SELLER_FEE_ON_ORDER_TAX", "SELLER_PENALTY_FEE", "SELLER_PENALTY_FEE_TAX"

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