Skip to content

Exporting Accounting Documents from Mirakl

This task will export accounting document information from your Mirakl account to an XML file.

Settings

Mirakl Connection

Required
The Mirakl connection to use. See the Connecting to Mirakl article if you require more information on how to create/manage connections.

Export Settings

Required
Settings to control whether new or all records will be exported from Mirakl. The following options are available:

  • Date Created - The date to use when exporting new records. Records created since this date will be exported. The date will update automatically each time the task runs.
  • Export New or All Records - Choose whether the task should export new or all records.

Export Transaction Lines

Required
Set to 'True' to include the transaction lines associated with each accounting document in the export.

Page Size

Required
The maximum number of records to fetch from the Mirakl API at a time. The value must be between 1 and 100, inclusive. Defaults to 100.

Payment Status

Required
Filters the export by payment status. The following options are available:

  • All
  • Failed
  • Paid
  • Pending

Shop ID

Optional
If your user has access to multiple shops, use this to filter the export by shop. If not specified, your default shop will be used.

Timeout

Optional
The length of time to wait for responses from the Mirakl API. If not specified, the timeout will default to 100 seconds.

Type

Required
Filters the export by document type. The following options are available:

  • All
  • AutoInvoice
  • ManualCredit
  • ManualInvoice

Output File

Required
The name of the file to export the data to. The data will be output in XML format, a sample of which is shown below.

Zynk Settings

See Common Task Settings

Examples

Sample output file:

<?xml version="1.0" encoding="utf-8"?>
<AccountingDocuments xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AccountingDocument Type="AUTO_INVOICE">
    <CurrencyIsoCode>USD</CurrencyIsoCode>
    <DateCreated>2025-01-28T05:07:17Z</DateCreated>
    <Details>
      <Detail>
        <AmountExclTaxes>724.52</AmountExclTaxes>
        <Description>Commissions of completed orders from 12/28/2024 to 01/28/2025</Description>
        <Quantity>1</Quantity>
        <Taxes>
          <Tax>
            <Amount>0.00</Amount>
            <Code>TAXDEFAULT</Code>
          </Tax>
        </Taxes>
      </Detail>
    </Details>
    <DueDate>2025-02-27T05:00:00Z</DueDate>
    <EndDate>2025-01-28T05:07:17Z</EndDate>
    <Id>336d574b-652e-426d-a044-f00c406d13aa</Id>
    <InvoiceId>232886</InvoiceId>
    <IssueDate>2025-01-28T05:07:17Z</IssueDate>
    <IssuingUser Type="BATCH">
      <Information>Automatic action</Information>
    </IssuingUser>
    <Payment>
      <State>PENDING</State>
    </Payment>
    <PaymentInfo Type="ABA">
      <BankAccountNumber>0123456789</BankAccountNumber>
      <BankName>JP MORGAN CHASE BANK NA</BankName>
      <Owner>Zynk Software Ltd</Owner>
      <RoutingNumber>012345678</RoutingNumber>
    </PaymentInfo>
    <ShopAddress>
      <City>New York</City>
      <Civility>Mr</Civility>
      <Country>USA</Country>
      <FirstName>John</FirstName>
      <LastName>Smith</LastName>
      <Phone>01911234567</Phone>
      <State>NY</State>
      <Street1>123 NORTH DRIVE</Street1>
      <ZipCode>41775</ZipCode>
    </ShopAddress>
    <ShopCorporateName>Zynk Software Ltd</ShopCorporateName>
    <ShopId>1234</ShopId>
    <ShopModel>MARKETPLACE</ShopModel>
    <ShopName>Zynk Software</ShopName>
    <ShopOperatorInternalId>12345678</ShopOperatorInternalId>
    <ShopTaxNumber>99-1234567</ShopTaxNumber>
    <StartTime>2024-12-28T05:06:41Z</StartTime>
    <State>COMPLETE</State>
    <Summary>
      <AmountTransferred>1740.23</AmountTransferred>
      <AmountTransferredToOperator>918.28</AmountTransferredToOperator>
      <TotalCommissionsExclTax>-792.92</TotalCommissionsExclTax>
      <TotalCommissionsInclTax>-792.92</TotalCommissionsInclTax>
      <TotalFeeExclTax>0.00</TotalFeeExclTax>
      <TotalFeeInclTax>0.00</TotalFeeInclTax>
      <TotalFeeOperatorRemittedExclTax>0.00</TotalFeeOperatorRemittedExclTax>
      <TotalFeeOperatorRemittedInclTax>0.00</TotalFeeOperatorRemittedInclTax>
      <TotalNonPayableOrdersExclTax>0.00</TotalNonPayableOrdersExclTax>
      <TotalNonPayableOrdersInclTax>0.00</TotalNonPayableOrdersInclTax>
      <TotalOperatorPaidShippingChargesExclTax>0.00</TotalOperatorPaidShippingChargesExclTax>
      <TotalOperatorPaidShippingChargesInclTax>0.00</TotalOperatorPaidShippingChargesInclTax>
      <TotalOperatorRemittedTaxes>-212.00</TotalOperatorRemittedTaxes>
      <TotalOtherCreditsExclTax>0.00</TotalOtherCreditsExclTax>
      <TotalOtherCreditsInclTax>0.00</TotalOtherCreditsInclTax>
      <TotalOtherInvoicesExclTax>0.00</TotalOtherInvoicesExclTax>
      <TotalOtherInvoicesInclTax>0.00</TotalOtherInvoicesInclTax>
      <TotalPayableOrdersExclTax>2692.75</TotalPayableOrdersExclTax>
      <TotalPayableOrdersInclTax>2904.75</TotalPayableOrdersInclTax>
      <TotalPurchaseTaxes>0.00</TotalPurchaseTaxes>
      <TotalRefundCommissionsExclTax>68.40</TotalRefundCommissionsExclTax>
      <TotalRefundCommissionsInclTax>68.40</TotalRefundCommissionsInclTax>
      <TotalRefundFeeExclTax>0.00</TotalRefundFeeExclTax>
      <TotalRefundFeeInclTax>0.00</TotalRefundFeeInclTax>
      <TotalRefundFeeOperatorRemittedExclTax>0.00</TotalRefundFeeOperatorRemittedExclTax>
      <TotalRefundFeeOperatorRemittedInclTax>0.00</TotalRefundFeeOperatorRemittedInclTax>
      <TotalRefundNonPayableOrdersExclTax>0.00</TotalRefundNonPayableOrdersExclTax>
      <TotalRefundNonPayableOrdersInclTax>0.00</TotalRefundNonPayableOrdersInclTax>
      <TotalRefundOperatorPaidShippingChargesExclTax>0.00</TotalRefundOperatorPaidShippingChargesExclTax>
      <TotalRefundOperatorPaidShippingChargesInclTax>0.00</TotalRefundOperatorPaidShippingChargesInclTax>
      <TotalRefundOperatorRemittedTaxes>18.24</TotalRefundOperatorRemittedTaxes>
      <TotalRefundOrdersExclTax>-228.00</TotalRefundOrdersExclTax>
      <TotalRefundOrdersInclTax>-246.24</TotalRefundOrdersInclTax>
      <TotalRefundPayableOrdersExclTax>-228.00</TotalRefundPayableOrdersExclTax>
      <TotalRefundPayableOrdersInclTax>-246.24</TotalRefundPayableOrdersInclTax>
      <TotalRefundPurchaseTaxes>0.00</TotalRefundPurchaseTaxes>
      <TotalSellerFeesOnOrdersExclTax>0.00</TotalSellerFeesOnOrdersExclTax>
      <TotalSellerFeesOnOrdersInclTax>0.00</TotalSellerFeesOnOrdersInclTax>
      <TotalSellerPenaltyFeesExclTax>0.00</TotalSellerPenaltyFeesExclTax>
      <TotalSellerPenaltyFeesInclTax>0.00</TotalSellerPenaltyFeesInclTax>
      <TotalSubscriptionExclTax>0.00</TotalSubscriptionExclTax>
      <TotalSubscriptionInclTax>0.00</TotalSubscriptionInclTax>
    </Summary>
    <TotalAmountExclTaxes>724.52</TotalAmountExclTaxes>
    <TotalAmountInclTaxes>724.52</TotalAmountInclTaxes>
    <TotalTaxes>
      <TotalTax>
        <Amount>0.00</Amount>
        <Code>TAXDEFAULT</Code>
      </TotalTax>
    </TotalTaxes>
    <TransactionLines>
      <TransactionLine Type="PAYMENT">
        <AccountingDocumentCreationDate>2025-01-28T05:07:17.132Z</AccountingDocumentCreationDate>
        <AccountingDocumentNumber>000000232886</AccountingDocumentNumber>
        <Amount>-1740.23</Amount>
        <AmountCredited>0.00</AmountCredited>
        <AmountDebited>1740.23</AmountDebited>
        <Balance>2415.43</Balance>
        <CurrencyIsoCode>USD</CurrencyIsoCode>
        <DateCreated>2025-01-28T05:07:16.95Z</DateCreated>
        <Entities />
        <Id>01234567-89ab-cdef-0123-456789abcdef</Id>
        <LastUpdated>2025-01-28T05:07:16.95Z</LastUpdated>
        <PaymentState>PAID</PaymentState>
      </TransactionLine>
      <TransactionLine Type="COMMISSION_VAT">
        <AccountingDocumentCreationDate>2025-01-28T05:07:17.132Z</AccountingDocumentCreationDate>
        <AccountingDocumentNumber>000000232886</AccountingDocumentNumber>
        <Amount>0.00</Amount>
        <AmountCredited>0.00</AmountCredited>
        <AmountDebited>0.00</AmountDebited>
        <Balance>4155.66</Balance>
        <CurrencyIsoCode>USD</CurrencyIsoCode>
        <DateCreated>2025-01-21T21:52:30.779Z</DateCreated>
        <Entities>
          <Domain>PRODUCT</Domain>
          <Order>
            <CommercialId>319934174-6025756</CommercialId>
            <CreationDate>2025-01-21T17:21:51.619Z</CreationDate>
            <Id>123456789-1234567-A</Id>
            <PaymentInfo>
              <PaymentType>Master Card</PaymentType>
            </PaymentInfo>
          </Order>
          <OrderLine>
            <Id>123456789-1234567-A-1</Id>
          </OrderLine>
          <ShopTax>
            <Code>TAXDEFAULT</Code>
            <Rate>0.0000</Rate>
          </ShopTax>
          <TransactionInfo>
            <Date>2025-01-21T21:52:30Z</Date>
            <Number>01234567-89ab-cdef-0123-456789abcdef-0</Number>
          </TransactionInfo>
        </Entities>
        <Id>01234567-89ab-cdef-0123-456789abcdef</Id>
        <LastUpdated>2025-01-28T05:07:16.95Z</LastUpdated>
        <PaymentState>PAID</PaymentState>
      </TransactionLine>
    </TransactionLines>
  </AccountingDocument>
</AccountingDocuments>