Last update 31/08/2022

Billing reports

With this functionality you can see the billing reports made by Mercado Libre for sellers. For this, we recommend you request /billing/period to obtain information on the last 12 periods, then with /bills ou will get all the invoices (documents) of a period, and finally, with /summary and /details you access the billing summary of a period and its details respectively.

Mercado Libre and Mercado Pago billing

Each of the endpoints allows us to obtain billing information from both Mercado Libre and Mercado Pago. Through the mandatory query group parameter we can specify from which billing group we want to obtain the information.

Notes:
- It is important that you take into account that the closing dates of the period expiration_date of each entity (MP | ML) they may not match.
So when looking at the endpoints that require entering a closing date of the period, the expiration_date used must be associated with the group (MP | ML) that was chosen at the time of consuming the “periods” endpoint, otherwise it will return incorrect information.

- Parameter document_type is required in /periods and optional in /documents.

- Parameter limit accepts 12 at most in /periods.

Get the period

Important:
The billing period may vary depending on the user. Also, you can´t use with TEST users.

Permite obtener información de los períodos de facturación para el grupo de facturación indicado (Mercado Libre o Mercado Pago). Por defecto se devuelven los últimos 6 periodos, con la posibilidad de consultar períodos más antiguos utilizando la paginación de offset y limit.

Note:
A través del parámetro document_type puede filtrar el tipo de documento que se desea obtener BILL | CREDIT_NOTE .

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods

Example:

curl -X GET  -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods?group=MP&document_type=BILL&offset=1&limit=2

Response:

{
  "offset": 1,
  "limit": 2,
  "total": 27,
  "results": [{
      "amount": 30.46000027656555,
      "unpaid_amount": 0.0,
      "period": {
        "date_from": "2020-02-19",
        "date_to": "2020-03-18"
      },
      "expiration_date": "2020-03-24",
      "debt_expiration_date": "2020-03-24",
      "debt_expiration_date_move_reason": null,
      "debt_expiration_date_move_reason_description": null,
      "period_status": "CLOSED"
    },
    {
      "amount": 477888.1484375,
      "unpaid_amount": 0.0,
      "period": {
        "date_from": "2020-01-19",
        "date_to": "2020-02-18"
      },
      "expiration_date": "2020-02-24",
      "debt_expiration_date": "2020-03-23",
      "debt_expiration_date_move_reason": "PAYMENT_ANNULMENT",
      "debt_expiration_date_move_reason_description": "Anulación de pago",
      "period_status": "CLOSED"
    }
  ]
}

Response fields

amount: total amount for the period.
unpaid_amount: total amount pending payment.
period: date range of the period.

  • date_from: start date of the period.
  • date_to: period end date.

expiration_date: is the period closing date. It is always reported when the period status is closed. Value used to consume the documents, details and summary endpoints.

debt_expiration_date: is the debt expiration date. In case the expiration date is not moved this field will be equal to expiration_date.
debt_expiration_date_move_reason: motivoreason for debt expiration date change. In case the expiration date is not moved this field will be null.
Valores posibles: : AUTOMATIC_DOCUMENT_CLOSURE_PROCES | RECEIPT_ANNULMENT_PROCESS_UNRECORDED | RECEIPT_ANNULMENT_PROCESS | PERIOD_EXTENDED_BY_ADMIN | PAYMENT_ANNULMENT

debt_expiration_date_move_reason_description: internationalized description of debt_expiration_date_move_reason. In case the expiration date is not moved this field will be null.

period_status: indicates whether the period is open or closed. Possible values:OPEN | CLOSED .


Get documents from a period

Allows you to obtain information on the documents (Invoices and Credit Notes) for a particular billing period for the indicated billing group (Mercado Libre or Mercado Pago).

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/$EXPIRATION_DATE/documents

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/202 1-06-02/documents?group=MP&document_type=BILL&limit=1

Response:

{
  "offset": 0,
  "limit": 1,
  "total": 2,
  "results": [{
    "id": 987654321,
    "user_id": 1234,
    "document_type": "BILL",
    "expiration_date": "2021-06-02",
    "associated_document_id": null,
    "amount": 3.86,
             "unpaid_amount": 0.0,
    "document_status": "BILLED",
    "site_id": "MLM",
    "period": {
      "date_from": "2021-05-03",
      "date_to": "2021-05-03"
    },
    "currency_id": "MXN",
    "count_details": 1,
     "files": [
               {
                   "file_id": "1234_FE_MEPF00869625_pdf",
                   "reference_number": "MEPF00999999"
               },
               {
                   "file_id": "1234_FE_MEPF00869625_xml",
                   "reference_number": "MEPF00999999"
               }
           ]
  }]
}

Optional filters

document_id: allows you to search by invoice id. Ex: document_id=987046992.
document_type: allows you to search by document type: Invoice or Credit Note. Possible values: BILL | CREDIT_NOTE.
offset: allows you to search from one result number onwards e.g. offset=100 (returns from result number 100).
limit: limits the number of results. By default the minimum is 150. Maximum allowed value: 1000. Ex: limit=300 (returns up to 300 results).



Billing summary

To know a summary of the charges and compensations that you had as a seller within a period of time, you must GET the Summary resource.

Note:
Through the document_type parameter you can filter the type of document to be obtained BILL | CREDIT_NOTE.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/$EXPIRATION_DATE/summary

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/2021-06 -02/summary?group=MP&document_type=BILL

Response:

{
  "user": {
    "nickname": "TEST"
  },
  "period": {
    "date_from": "2021-05-01",
    "date_to": "2021-06-01",
    "expiration_date": "2021-06-02"
  },
  "summary": {
    "amount": 545562.37,
    "credit_note": 0,
    "tax": 0.00,
    "bonuses": [{
      "label": "Bonificación de MercadoPago",
      "amount": 7354.60
    },
    {
      "label": "Bonificación Impuesto a los Ingresos Brutos Cap. Fed.",
      "amount": 116.43
    },
    {
      "label": "Bonificación Impuesto al Valor Agregado Régimen General",
      "amount": 116.43
    }
    ],
    "charges": [{
        "label": "Cargo de MercadoPago",
        "amount": 524228.80
      },
      {
        "label": "Percepción General IIBB de CABA",
        "amount": 13003.72
      }, {
        "label": "Percepción IVA Régimen General",
        "amount": 13003.72

      },
      {
        "label": "Cargo por transferencia de dinero",
        "amount": 2913.59
      }
    ]
  }
}

Campos de la respuesta

summary: here we will see the Charges and Bonuses that the seller had.
amount: it is the total to pay within the consulted billing period. It is formed with the sum of Charges and Taxes and subtraction of the Bonuses.
credit_note: they are the bonuses of charges generated in other periods. Credit notes are used to pay bills due.
tax: they are the perceptions generated by the different tax regimes.
bonuses: it is the refund of commissions for your sales and services that did not materialize. You will see them discriminated according to the type of bonus.

  • label: bonus name
  • amount: bonus price.

The bonuses can be for the following concepts:

Sales and shipping charges: If a sale fails due to a return or mail problems (such as product loss or damage), we refund the sales commission and shipping charge.

Advertising charges: If by mistake you hired the service or there was a problem with the collection, we will refund the difference.

Tax Perceptions Bonuses: When a sales charge is returned, the corresponding refund of the IVA tax collection (either for a new or a used item) and of Gross Income is also included. The same if there were errors in the application of a perception.

charges: They represent the different charges that the seller may have: sales commissions, publication costs, tax receipts, service charges (Example: Mercado Envios, Mercado Shops etc.)

In case of hiring advertising campaigns, they also appear here.


Settlement detail

Allows you to obtain the detail to reconcile invoices and sales charges for a particular period, the billing group (Mercado Libre or Mercado Pago) and the type of document (Invoice or Credit Note). This information is the same that is available through the billing reports section.

Notes:
- If queries with an offset greater than 10,000, we recommend you use the filters and narrow down the results, avoiding delayed responses.
- Through the document_type parameter you can filter the type of document you want to get BILL | CREDIT_NOTE.

Mercado Libre

In the case of Mercado Libre, the details of the invoiced charges, sale information, discounts, shipping and publication information are shown.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/$EXPIRATION_DATE/group/ML/details

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/2021-06-02/group/ML/details?document_type=BILL&limit=1

Response:

{
   "offset": 0,
   "limit": 150,
   "total": 1,
   "results": [
       {
           "charge_info": {
               "legal_document_number": "0001A00123456",
               "legal_document_status": "PROCESSED",
               "legal_document_status_description": "Procesado",
               "creation_date_time": "2021-05-13T08:08:24",
               "detail_id": 123456789,
               "detail_amount": 342.49,
               "transaction_detail": "Cargo por Mercado Envíos",
               "debited_from_operation": "YES",
               "debited_from_operation_description": "Si",
               "status": null,
               "status_description": null,
               "charge_bonified_id": null,
               "detail_type": "CHARGE",
               "detail_sub_type": "CXD",
               "concept_type": "SHIPPING"
           },
           "discount_info": {
               "charge_amount_without_discount": 684.99,
               "discount_amount": 342.5,
               "discount_reason": "Descuento general"
           },
           "sales_info": [
               {
                   "order_id": 12345,
                   "operation_id": null,
                   "sale_date_time": "2021-05-13T08:05:10",
                   "sales_channel": "Mercado Libre",
                   "payer_nickname": "ABCD",
                   "state_name": "Neuquén",
                   "transaction_amount": 2499
               },
            ],
           "shipping_info": {
               "shipping_id": "123456789",
               "pack_id": "200000123456789",
               "receiver_shipping_cost": 0
           },
           "items_info": [
               {
                   "item_id": "MLA987654321",
                   "item_title": "Fabrica Magdalenas Cup Cake Maker Atma Cm8910e",
                   "item_type": "gold_special",
                   "item_type_description": "Clásica",
"item_category": "Electrodomésticos y Aires Ac. > Pequeños Electrodomésticos > Para Cocina > Máquinas para Postres > Máquinas de Cupcakes",
                   "inventory_id": null,
                   "item_amount": 1,
                   "item_price": 2499,
                   "order_id": 1234
               }
           ],
           "document_info": {
               "document_id": 1615633359
           },
           "marketplace_info": {
               "marketplace": "SHIPPING"
           },
           "currency_info": {
               "currency_id": "ARS"
           }
       }
   ],
   errors:[]
}

Mercado Pago

For Mercado Pago, the detail of invoiced charges is shown with complementary information on the Mercado Pago operation, such as movements, payment methods, payer, branch, point of sale, among others.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/$EXPIRATION_DATE/group/MP/details

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/2021-06-02/group/MP/details?document_type=BILL&limit=1

Response:

{
   "offset": 0,
   "limit": 1,
   "total": 9,
   "results": [
       {
           "charge_info": {
               "legal_document_number": null,
               "legal_document_status": "PROCESSING",
               "legal_document_status_description": "En proceso",
               "concept_id": "12345678",
               "transaction_detail": "Cargo de MercadoPago",
               "creation_date_time": "2021-06-01T17:45:39",
               "detail_amount": 13.8,
       "detail_type": "CHARGE",
       "detail_sub_type": "CCMP"
               
           },
           "operation_info": {
               "operation_type": "BUY",
               "operation_type_description": "Pago",
               "reference_id": 12345678,
               "sales_channel": "Point",
               "store_id": 2222222,
               "store_name": "Store",
               "external_reference": "Venta presencial",
               "payer_nickname": "TEST",
               "transaction_amount": 340
           },
           "perception_info": {
               "aliquot": null,
               "taxable_amount": null
           },
          "document_info": {
       "document_id": 8888899999,
      },
     "market_type_info": {
       "marketplace": "MP"
           },
 
           "currency_info": {
               "currency_id": "MXN"
           }
       }
   ]
}

Optional filters

  • date_sort: allows you to sort the search.
    asc: sorts results ascending (default value).
    desc: sorts the results descendingly.
    Ex: date_sort=asc
  • sort_by: allows you to select by which field to sort. Possible values: DATE
  • detail_type allows you to search by detail type.
    charge: brings only charges.
    bonus: retrieves only bonuses.
    Ex: det_type=charge
  • detail_sub_types: allows filtering by detail subtypes. Several can be defined separated by comma.
    Ex: detail_sub_types=CV, BV
  • detail_excluded_sub_types: allows the specified detail subtypes to be excluded from the search. Several subtypes can be defined separated by commas.
    Ex: not_subtypes=CXD, BXD
  • marketplace_type: allows you to search by the marketplace of the detail.
    Ex: marketplace_type=SHIPPING
  • order_ids: allows you to search by one or more order ids. Available for ML.
    Ex: order_ids=2294412230.
  • item_ids: allows you to search by one or more id of the publication.
    Ex: item_ids=724159812.
  • document_ids: allows you to search by one or more invoice ids.
    Ex: document_ids=987046992
  • detail_ids: allows you to search by one or more detail ids.
    Ex: detail_ids=724159812
  • offset: allows searching from one result number onwards. The minimum value allowed is 0 and the maximum value allowed is 10000. The default value is 0. Ex: offset=100 (returns from result number 100).
  • limit:limits the number of results. By default the minimum is 1 and the maximum allowed value: 1000 . Ex: limit=300 (returns up to 300 results).
    Ex: limit=300 (returns up to 300 results).


Mercado Libre response fields

charge_info: position information.

  • legal_document_number: document number.
  • legal_document_status: document generation status. Possible values: PROCESSING | PROCESSED.
  • legal_document_status_description: internationalized description of the legal document status_document_status.
  • creation_date_time: date of creation of the position.
  • detail_id: position identifier.
  • transaction_detail: position detail.
  • debited_from_operation: indicates whether it is discounted from the transaction. Possible values: YES | NO | INAPPLICABLE.
  • debited_from_operation_description: internationalized description of the debited_from_operation field.
  • status: status of the position. Possible values: BONUS_ON_CREDIT_NOTE | BONUS_PART_ON_CREDIT_NOTE | BONUS_ON_BILL | BONUS_PART_ON_BILL | BONUS_ON | BONUS_PART_ON.
  • status_description: internationalized status description.
  • charge_bonified_id: bonus position identifier.
  • detail_amount: amount of the charge.
  • detail_type: type of detail.
  • detail_sub_type: subtypes of details.

discount_info: discount information.

  • charge_amount_without_discount: value of the charge without discount.
  • discount_amount: discount value.
  • discount_reason: reason for the discount.

sales_info: sales information.

  • order_id: sale identifier.
  • operation_id: payment identifier.
  • sale_date_time: date and time of sale.
  • sales_channel: sales channel.
  • payer_nickname: customer.
  • state_name: province.
  • transaction_amount: total amount of the sale.

shipping_info: shipping information.

  • shipping_id: shipment identifier.
  • pack_id: ackage identifier.
  • receiver_shipping_cost: shipping at customer's expense.

items_info: information on publications.

  • item_id: publication identifier.
  • item_title: title of the publication
  • item_type: type of publication.
  • item_category: publication category.
  • inventory_id: code of Mercado Libre.
  • item_amount: number of items sold.
  • item_price: unit price of the item.
  • order_id: order to which the item belongs.

documentInfo: document information.

  • document_id: Id number of documents.

marketplaceInfo: marketplace information.

  • marketplace: marketplace name.

currency_info: currency information according to the site_id.

  • currency_id: currency identifier according to the site_id.


Mercado Pago response fields

charge_info: information of the position.

  • legal_document_number: document number.
  • detail_id: position identifier.
  • movement_id: movement number.
  • transaction_detail: detail.
  • creation_date_time: date of the position.
  • detail_amount: amount of the charge.
  • detail_type: type of detail.
  • detail_sub_type: subtypes of details.

operation_info: information of the operation to which it applies.

  • operation_type: type of operation. Possible values BUY | TAX .
  • operation_type_description: internationalized description of the operation field.
  • reference_id: related operation number.
  • sales_channel: type of payment.
  • store_id: branch number.
  • store_name: name of the branch.
  • external_reference: external reference number.
  • payer_nickname: customer.
  • transation_amount: amount of the operation.

perception_info: perception information.

  • aliquot: value of the aliquot.
  • taxable_amount: taxable income.

documentInfo: document information.

  • document_id: Id number of documents.

marketplaceInfo: marketplace information.

  • marketplace: marketplace name.

currency_info: currency information according to site_id.

  • currency_id: currency identifier according to the site_id.


Allows you to download the legal invoices from Mercado Libre and Mercado Pago in PDF format.

Notes:
- The file_id In some cases the Documents endpoint may return two file_id. Only in these cases note that the file_id corresponding to the PDF must be used.

- If the Document endpoint returns a single file_id. Then you must use that data for the legal document download.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/legal_document/$FILE_ID

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/legal_document/1234_FE_MEPF00869625_pdf

Response: Download the file in PDF format..



Download reconciliation detail report in XLSX and CSV format.

To download the Mercado Libre and Mercado Pago reconciliation reports in XLSX and CSV formats, you must follow a three-step report generation process: First the reconciliation report is generated, then you have to check the report generation status until it is generated and finally you proceed to download it.


1. Report generation

Through this endpoint, the report is generated.

Request:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN' -H "Content-Type: application/json" -d {...}
https://api.mercadolibre.com/billing/integration/periods/$EXPIRATION_DATE/reports

Example:

curl -X POST -H 'Authorization: Bearer $ACCESS_TOKEN'
-d '{
   "group": "MP",
   "document_type": "BILL",
   "report_format": "CSV"
}' 
https://api.mercadolibre.com/billing/integration/periods/2021-08 -04/reports

Response:

{
"fileId": "ML-report-BILL-2021-08-04-11119999-CSV-v2"
}

2. Report generation status

Through this endpoint, it is possible to obtain the report generation status. The statuses can be:

  • PROCESSING: the report is being generated.
  • READY: the report is finished generating.
  • ERROR: report generation failed, must be re-consulted.

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/$FILE_ID/status

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/ML-repo rt-BILL-2021-08-04-11119999-CSV-v2/status?document_type=BILL

Response:

{
"status": "PROCESSING"
}

3. Report download

A través de este endpoint se permite realizar la descarga del reporte. Esta descarga podrá ser efectiva una vez que el estado de la generación sea “Ready”.


Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/$FILE_ID

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/reports/ML-repo rt-BILL-2021-08-04-11119999-CSV-v2?document_type=BILL

Summary of perceptions

Important:
Applies only for Argentina.

Allows you to obtain the summary of payments made by the seller for a particular period, the billing group (Mercado Libre or Mercado Pago).


Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/$EXPIRATION_DATE/perceptions/summary

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/periods/2021-08-02/perceptions/summary?group=MP

Response:

{
"summary": [
       {
        "document_id": 123456789,
        "society": "ML",
        "legal_document_number": "0011A012345678",
        "user_fiscal_condition": "Responsable inscripto sin incumplimientos",
        "amount": 229314.11,
        "regimen_tax_type": "MLA_RE_IVA_N",
        "regimen_tax_type_description": "Percepción de IVA nuevos del régimen 
especial",
        "taxable_amount": 22931410.96,
        "aliquot": 1.00,
           "coefficient": 1.0000,
           "perception_charge_number": 1123456789,
           "tax_type": "CRGI",
           "tax_type_description": 
"Percepción Impuesto al Valor Agregado nuevos",
           "bill_date": "2021-11-29",
           "status": "APPLIED",
           "status_description": "Aplicado"
      "tax_ids": [123345678,233455678]  
       }
],
"errors": []
}


Response fields

summary: summary information.

  • document_id: document identifier.
  • society: society. Possible values ML | MP.
  • legal_document_number: document number.
  • user_fiscal_condition: tax status of the user.
  • amount: total payable within the period consulted.
  • regimen_tax_type: tax rate regime.
  • regimen_tax_type_description: internationalized description of the tax rate regime.
  • taxable_amount: taxable income.
  • aliquot: value of the aliquot.
  • coefficient: coefficient involved in the calculation of the tax.
  • perception_charge_number: charge number of perception charge.
  • tax_type: tax rate.
  • tax_type_description: internationalized description of the tax rate.
  • bill_date: billing date.
  • status: summary status.
  • status_description: internationalized description of the state.
  • tax_ids: types of taxes.

Detail of perceptions

Important:
Applies only to Argentina.

Allows you to obtain the details of a specific perception. For Mercado Libre perceptions from the perception code and the document number. For Mercado Pago perceptions from the perception code, the document number and the tax identifier.

Notes:
- Mercado Pago: with the field tax_type, document_id and tax_id you can access the details of the payment and the document indicated in the filters.
- Mercado Libre: with the field tax_type, document_id you can access to the detail of the perception and of the document indicated in the filters.
- These fields are obtained from the Perception Summary endpoint.
- The result fields vary according to the tax_type consulted: General Regime, Special Regime, Tucumán Regime.

Mercado Libre

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/group/ML/perceptions/details

Example (General Regime)::

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/group/ML/perceptions/details?document_id=333555777&tax_type=CIVA&offset=1&limit=2

Response (General Regime)::

{
   "offset": 0,
   "limit": 150,
   "total": 4241,
   "results": [
       {
           "detail_id": 12345678,
           "date_created": "2021-10-30",
           "taxable_amount": 2660.0,
           "aliquot": 3.0,
           "tax_amount": 79.8,
           "transaction_detail": "CV",
           "transaction_detail_description": "Cargo por venta",
           "charge_bonified_id": null,
           "amount": 2660.0,
           "gross_amount": 3218.6,
           "detail_type": "CHARGE",
           "detail_type_description": "Cargo"
       }],
   "errors": []
}

Mercado Pago

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/group/MP/perceptions/details

Example (General Regime):

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/billing/integration/group/MP/perceptions/details?document_id=333555777&tax_type=CIVAMP&tax_id=12345&tax_id=12345&offset=1&limit=2

Response (General Regime):

{
   "offset": 0,
   "limit": 150,
   "total": 5,
   "results": [
       {
           "detail_id": 1114444,
           "date_created": "2021-10-30",
           "taxable_amount": 154.93,
           "aliquot": 3.0,
           "tax_amount": 4.6479,
           "movement_id": "1234567",
           "reference_id": 1234567,
           "transaction_detail": "CCMP",
           "transaction_detail_description": "Cargo de MercadoPago",
           "amount": 154.93,
           "gross_amount": 187.46,
           "detail_type": "CHARGE",
           "detail_type_description": "Cargo"
       }],
   "errors": []
}


Response fields

The following data is returned for Mercado Libre and for a General Regime perception:

detail_id: detail identifier.

date_created: creation date.

taxable_amount: taxable amount.

aliquot: tax rate value.

tax_amount: tax amount.

transaction_detai: transaction detail.

transaction_detail_description: internationalized description of transaction detail.

charge_bonified_id: identifier of the charge that bonifies in case the charge is a bonus. amount: amount of the charge.

amount: gross amount of the charge.

gross_amount: type of detail to which the charge applies.

detail_type: type of detail to which the charge applies.

detail_type_description: description of the type of detail to which the benefit applies.


For Mercado libre and for a Special Regime collection, the following data are also reported:

publish_number: publication number.

publish_title: title of the publication.

sale_date: date of sale.

sale_number: sale number.

buyer_name: buyer number.

buyer_state_name: buyer's state.


For Mercado Libre and for a perception of the Tucumán Regime, the following data is also reported:

coefficient: coefficient with which the amount of the tax is calculated.


For Mercado Pago the following information is also provided:

movement_id: movement number.

reference_id: related operation.


HTTP response code

206 - Partial content: in some cases, the endpoints will return the code 206 - Partial content. This will occur when the request to some of the data (e.g. discount of a detail) fails to inform you that you will receive an incomplete response. Errors can be displayed in the errors field of the endpoint response.


Field structure errors:

"errors": [
       {
           "index": 3,
           "error_type": "PARTIAL_CONTENT",
           "messages": "An error occurred while retrieving the information. Try again"    
       },
]

Field description:

index: position of the object that could not be retrieved.

date_created: error type.

taxable_amount: error description.

Note:
Applies to all endpoints, except for legal document download and reconciliation detail report download in XLSX and CSV format.


Possible Errors

The expected errors that may occur in the application will be returned taking into account the following structure:

{
   "timestamp": string($date-time),
   "status": integer($int32),
   "type": string,
   "message": string,

  "path": string,
   "errors": {

<*>: string }
}

timestamp: reports the date and time at which the error was generated.

status: reports the error code returned.

type: application error code. Possible values:

  • ABUSE_PREVENTION_ERROR
  • AUTHENTICATION_ERROR
  • AUTHORIZATION_ERROR
  • BAD_REQUEST_ERROR
  • VALIDATION_ERROR
  • TYPE_MISMATCH_ERROR
  • INTERNAL_ERROR
  • MISSING_PARAMETER_ERROR
  • METHOD_NOT_ALLOWED_ERROR
  • NOT_FOUND_ERROR

message: indicates an error message.

path: reports the endpoint that was consumed.

errors: reports the errors that occurred.


Example:

{
   "timestamp": "2021-07-07T21:21:09.72319Z",
   "status": 422,
   "type": "TYPE_MISMATCH_ERROR",
   "message": "Type mismatch error.",
   "path": "/periods",
   "errors": {
       "group": "Invalid format for value "
   }
}
banner footer

Subscribe to our Newletter

or register to recieve the latest news about our API