Liquidaciones

Obtener liquidaciones

GET /v1/settlements

Este endpoint devuelve las liquidaciones de un comercio en un rango de fechas, de forma paginada. Disponible con credenciales CUSTOMER y MERCHANT: con credenciales CUSTOMER se consultan los comercios del cliente; con credenciales MERCHANT, el comercio propio.

Datos de consulta

ParámetrosDescripción
merchantId
  • string
  • Identificador del comercio
start
  • date
  • La fecha de inicio del rango de búsqueda
  • [yyyy-MM-dd, yyyy-MM-ddTHH:mm:ssXXX]
end
  • date
  • La fecha de fin del rango de búsqueda
  • [yyyy-MM-dd, yyyy-MM-ddTHH:mm:ssXXX]
page
  • integer
  • El número de la página de resultados a obtener (>=0)
size
  • integer
  • El número de resultados por página

Datos de respuesta

Cada elemento de content es una liquidación. Los campos sin valor se omiten.

ParámetrosDescripción
settlement_id
  • (opcional)
  • string
  • Identificador de la liquidación
customer_id
  • (opcional)
  • string
  • Identificador del cliente
merchant_id
  • (opcional)
  • string
  • Identificador del comercio
business_name
  • (opcional)
  • string
  • Razón social del comercio
customer_business_name
  • (opcional)
  • string
  • Razón social del cliente
tax_type
  • (opcional)
  • string
  • Tipo de identificación fiscal
tax_id
  • (opcional)
  • string
  • Número de identificación fiscal
tax_condition
  • (opcional)
  • string
  • Condición fiscal
address
  • (opcional)
  • string
  • Domicilio
city
  • (opcional)
  • string
  • Ciudad
state
  • (opcional)
  • string
  • Provincia o estado
zip_code
  • (opcional)
  • string
  • Código postal
country
  • (opcional)
  • string
  • País
currency
  • (opcional)
  • string
  • Moneda
payment_method
  • (opcional)
  • string
  • Método de pago
next_payment_date
  • (opcional)
  • string
  • Fecha de pago
total_operations
  • (opcional)
  • integer
  • Cantidad de operaciones
gross_amount
  • (opcional)
  • number
  • Monto bruto
gross_amount_without_tip
  • (opcional)
  • number
  • Monto bruto sin propinas
gross_amount_without_advance
  • (opcional)
  • number
  • Monto bruto sin adelantos
tip
  • (opcional)
  • number
  • Monto de propinas
advance
  • (opcional)
  • number
  • Monto de adelantos
commission
  • (opcional)
  • number
  • Comisión
commission_vat
  • (opcional)
  • number
  • IVA sobre la comisión
financial_cost
  • (opcional)
  • number
  • Costo financiero
financial_cost_vat
  • (opcional)
  • number
  • IVA sobre el costo financiero
iva
  • (opcional)
  • number
  • IVA
ganancias
  • (opcional)
  • number
  • Impuesto a las ganancias
taxed_amount
  • (opcional)
  • number
  • Monto gravado
  curl --request GET \
    --url 'https://api.menta.global/api/v1/settlements' \
    --header 'Authorization: Bearer {access_token}' \
    --url-query 'merchantId=string' \
    --url-query 'start=string' \
    --url-query 'end=string' \
    --url-query 'page=integer' \
    --url-query 'size=integer'
  {
    "content": [
      {
        "merchant_id": "string",
        "customer_id": "string",
        "business_name": "string",
        "customer_business_name": "string",
        "tax_type": "string",
        "tax_id": "string",
        "address": "string",
        "city": "string",
        "state": "string",
        "zip_code": "string",
        "country": "string",
        "currency": "string",
        "tax_condition": "string",
        "settlement_id": "string",
        "payment_method": "string",
        "commission": 0,
        "financial_cost": 0,
        "iva": 0,
        "ganancias": 0,
        "taxed_amount": 0,
        "next_payment_date": "string",
        "total_operations": 0,
        "gross_amount": 0,
        "commission_vat": 0,
        "financial_cost_vat": 0,
        "tip": 0,
        "advance": 0,
        "gross_amount_without_tip": 0,
        "gross_amount_without_advance": 0
      }
    ],
    "pageable": {
      "sort": {
        "sorted": true,
        "unsorted": true,
        "empty": true
      },
      "page_number": 0,
      "page_size": 0,
      "offset": 0,
      "paged": true,
      "unpaged": true
    },
    "total_pages": 0,
    "total_elements": 0
  }