Recepciones

Mercadería recibida del proveedor: líneas con precio del remito y costo, correcciones de antes y después. La anulación marca voided_at.

Cargando el índice de búsqueda…

Recepciones

Objetos

GoodsReceipt

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • numberstring o nullobligatorio

    Número de la recepción; null en una recepción creada antes de la numeración.

  • supplier_idinteger o nullobligatorio

    ID del proveedor (/v1/suppliers); null en una recepción sin proveedor.

  • location_idintegerobligatorio

    Local donde se recibió la mercadería (/v1/locations).

  • legal_entity_idinteger o nullobligatorio

    Razón social compradora de la tienda (/v1/legal-entities): su régimen decide si el impuesto de la compra se computa como crédito; null en recepciones antiguas.

  • purchase_order_idinteger o nullobligatorio

    Orden de compra contra la que se recibió (/v1/purchase-orders); null si se recibió sin orden.

  • received_atstring (date-time)obligatorio

    Cuándo se recibió la mercadería.

  • currencystringobligatorio

    Moneda de la recepción, ISO 4217: en ella van los precios del remito, los totales de línea y el subtotal.

  • exchange_ratestring o nullobligatorio

    Tipo de cambio de la moneda de la recepción a la moneda de la tienda como texto decimal, tomado al recibir; null si la recepción no lo guardó.

  • settlement_modestring o nullobligatorio

    Cómo paga la tienda la entrega: on_receipt: por lo recibido; on_sale: al vender, con una liquidación de consignación; null en recepciones antiguas.

    Valores:
    on_receipton_salenull
  • supplier_documentobjectobligatorio

    Remito del proveedor tal como lo confirmó el personal.

    Campos · 3
    • type_codestring o nullobligatorio

      Código del tipo de comprobante del proveedor fiscal del país de la tienda (en Argentina, el código de comprobante de ARCA); null si no hay documento.

    • numberstring o nullobligatorio

      Número del remito; null si no se indicó.

    • datestring o nullobligatorio

      Fecha del remito, YYYY-MM-DD; null si no se indicó.

  • prices_include_taxboolean o nullobligatorio

    true: los precios de las líneas incluyen impuestos; false: no los incluyen; null: no se indicó.

  • input_tax_treatmentstring o nullobligatorio

    Adónde fue el impuesto del precio de compra: recoverable: se computa como crédito y el costo va sin impuesto; cost: no hay contra qué computarlo y el impuesto es parte del costo; null: costo tal como se cargó.

    Valores:
    recoverablecostnull
  • lines_subtotalinteger o nullobligatorio

    Valor recibido: la suma de line_total en la moneda de la recepción; null si el documento no tiene precios.

  • payable_totalinteger o nullobligatorio

    Monto que se le debe al proveedor en la moneda de la recepción; null si se desconoce.

  • voided_atstring (date-time) o nullobligatorio

    Cuándo se anuló la recepción: la mercadería salió del stock y se anuló la deuda por la entrega; null en una recepción vigente.

  • notestring o nullobligatorio

    Nota del personal; null si no hay.

  • linesarray de objectobligatorio

    Líneas de la recepción; los valores son después de las correcciones.

    Campos · 16
    • idintegerobligatorio

      ID del registro, único entre los registros de su tipo en la tienda.

    • variant_idinteger o nullobligatorio

      ID de la variante del producto (/v1/variants).

    • lot_idinteger o nullobligatorio

      Lote de la línea (/v1/lots); null en un producto sin lotes.

    • purchase_order_line_idinteger o nullobligatorio

      Línea de la orden de compra (lines[].id de la orden) contra la que se recibió; null sin orden.

    • added_by_correction_idinteger o nullobligatorio

      Corrección (corrections[].id) que agregó la línea; null en una línea del registro original.

    • supplier_descriptionstring o nullobligatorio

      Nombre del artículo como figura en el remito; null si no se registró.

    • supplier_quantitystring o nullobligatorio

      Cantidad como figura en el remito, en supplier_unit, como texto decimal; null si no se registró.

    • supplier_unitstring o nullobligatorio

      Unidad del remito tal como está escrita: «kg», «15 kg», «u»; null si no se indicó.

    • unitstring o nullobligatorio

      Unidad base de quantity y cost_per_quantity: pcs, unidades; g, gramos; ml, mililitros.

    • quantitystring o nullobligatorio

      Cantidad ingresada al stock, texto decimal en la unidad base.

    • unit_costinteger o nullobligatorio

      Precio del remito en la moneda de la recepción por cost_per_quantity; null si no hay precio.

    • cost_per_quantitystring o nullobligatorio

      Cantidad en la unidad base a la que corresponde el precio: "1000" en un producto por peso es por kilo.

    • line_totalinteger o nullobligatorio

      Total de la línea en la moneda de la recepción: precio por la cantidad del remito; null sin precio o sin cantidad del remito.

    • store_unit_cost_microinteger o nullobligatorio

      Precio de la línea en la moneda de la tienda al tipo de cambio de la recepción por cost_per_quantity, en millonésimas de la unidad menor; null sin precio.

    • tax_rate_bpsinteger o nullobligatorio

      Alícuota con la que se calculó el costo, en puntos básicos; null si no hubo tratamiento del impuesto.

    • landed_unit_cost_microinteger o nullobligatorio

      Costo después del tratamiento del impuesto que la línea fijó en el artículo: moneda de la tienda, por cost_per_quantity, en millonésimas de la unidad menor; null sin precio.

  • correctionsarray de objectobligatorio

    Correcciones de la recepción registrada en orden: qué se corrigió y por qué.

    Campos · 8
    • idintegerobligatorio

      ID del registro, único entre los registros de su tipo en la tienda.

    • numberstringobligatorio

      Número de la corrección.

    • reasonstringobligatorio

      Por qué se corrigió, con las palabras del personal.

    • subtotal_beforeinteger o nullobligatorio

      lines_subtotal antes de la corrección; null si no había precios.

    • subtotal_afterinteger o nullobligatorio

      lines_subtotal después de la corrección; null si no hay precios.

    • consumed_varianceintegerobligatorio

      Diferencia de precio sobre lo que ya había salido del stock, en la moneda de la tienda: fue al costo de lo vendido.

    • linesarray de objectobligatorio

      Líneas corregidas, antes y después.

      Campos · 11
      • goods_receipt_line_idintegerobligatorio

        ID de la línea de la recepción (lines[].id).

      • quantity_beforestring o nullobligatorio

        Cantidad recibida antes de la corrección, en la unidad base.

      • quantity_afterstring o nullobligatorio

        Cantidad recibida después de la corrección, en la unidad base.

      • supplier_quantity_beforestring o nullobligatorio

        Cantidad del remito antes de la corrección; null si no había.

      • supplier_quantity_afterstring o nullobligatorio

        Cantidad del remito después de la corrección; null si no hay.

      • unit_cost_beforeinteger o nullobligatorio

        Precio del remito antes de la corrección; null si no había precio.

      • unit_cost_afterinteger o nullobligatorio

        Precio del remito después de la corrección; null si no hay precio.

      • store_unit_cost_before_microinteger o nullobligatorio

        Precio en la moneda de la tienda antes de la corrección, en millonésimas de la unidad menor.

      • store_unit_cost_after_microinteger o nullobligatorio

        Precio en la moneda de la tienda después de la corrección, en millonésimas de la unidad menor.

      • consumed_quantitystring o nullobligatorio

        Cuánto de la línea ya había salido del stock al momento de la corrección.

      • consumed_varianceintegerobligatorio

        Diferencia de precio sobre lo que salió del stock, en la moneda de la tienda.

    • created_atstring (date-time)obligatorio

      Cuándo se registró la corrección.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

  • updated_atstring (date-time)obligatorio

    Cuándo cambió el registro por última vez.

Endpoints

Recepciones: ingresos de mercadería del proveedor con líneas, precios del remito y correcciones

get/goods-receipts

Scope: procurement:read

Parámetros

Query

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.

    Largo máximo:
    4096
  • updated_sincestring (date-time)

    Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.

    Patrón:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • supplier_idinteger

    Solo documentos de este proveedor.

    Mínimo:
    1
  • purchase_order_idinteger

    Solo recepciones de esta orden de compra.

    Mínimo:
    1

Respuestas

200Éxito

application/json

  • dataarray de GoodsReceiptobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.

    Campos · 2
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Errores de este endpoint

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/goods-receipts" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "data": [
    {
      "id": 0,
      "number": "string",
      "supplier_id": 0,
      "location_id": 0,
      "legal_entity_id": 0,
      "purchase_order_id": 0,
      "received_at": "2026-01-15T12:00:00Z",
      "currency": "string",
      "exchange_rate": "string",
      "settlement_mode": "on_receipt",
      "supplier_document": {
        "type_code": "string",
        "number": "string",
        "date": "string"
      },
      "prices_include_tax": true,
      "input_tax_treatment": "recoverable",
      "lines_subtotal": 0,
      "payable_total": 0,
      "voided_at": "2026-01-15T12:00:00Z",
      "note": "string",
      "lines": [
        {
          "id": 0,
          "variant_id": 0,
          "lot_id": 0,
          "purchase_order_line_id": 0,
          "added_by_correction_id": 0,
          "supplier_description": "string",
          "supplier_quantity": "string",
          "supplier_unit": "string",
          "unit": "string",
          "quantity": "string",
          "unit_cost": 0,
          "cost_per_quantity": "string",
          "line_total": 0,
          "store_unit_cost_micro": 0,
          "tax_rate_bps": 0,
          "landed_unit_cost_micro": 0
        }
      ],
      "corrections": [
        {
          "id": 0,
          "number": "string",
          "reason": "string",
          "subtotal_before": 0,
          "subtotal_after": 0,
          "consumed_variance": 0,
          "lines": [
            {
              "goods_receipt_line_id": 0,
              "quantity_before": "string",
              "quantity_after": "string",
              "supplier_quantity_before": "string",
              "supplier_quantity_after": "string",
              "unit_cost_before": 0,
              "unit_cost_after": 0,
              "store_unit_cost_before_micro": 0,
              "store_unit_cost_after_micro": 0,
              "consumed_quantity": "string",
              "consumed_variance": 0
            }
          ],
          "created_at": "2026-01-15T12:00:00Z"
        }
      ],
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Recepción

get/goods-receipts/{goods_receipt}

Scope: procurement:read

Parámetros

Ruta

  • goods_receiptintegerobligatorio

    ID de la recepción.

Respuestas

200Éxito

application/json

Devuelve GoodsReceipt

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer

application/problem+json

Devuelve Problem

403El plan, la dirección IP o los scopes del token no permiten la solicitud

Encabezados

  • WWW-Authenticatestring

    Esquema de autenticación (RFC 6750).

    Ejemplo:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Devuelve ForbiddenProblem

404El objeto no existe o no está disponible para la aplicación

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

429Se agotó el límite de solicitudes

Encabezados

  • Retry-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve Problem

Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores

Ejemplo de solicitud
curl "https://api.saleya.app/v1/goods-receipts/{goods_receipt}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "number": "string",
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "purchase_order_id": 0,
  "received_at": "2026-01-15T12:00:00Z",
  "currency": "string",
  "exchange_rate": "string",
  "settlement_mode": "on_receipt",
  "supplier_document": {
    "type_code": "string",
    "number": "string",
    "date": "string"
  },
  "prices_include_tax": true,
  "input_tax_treatment": "recoverable",
  "lines_subtotal": 0,
  "payable_total": 0,
  "voided_at": "2026-01-15T12:00:00Z",
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "lot_id": 0,
      "purchase_order_line_id": 0,
      "added_by_correction_id": 0,
      "supplier_description": "string",
      "supplier_quantity": "string",
      "supplier_unit": "string",
      "unit": "string",
      "quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "line_total": 0,
      "store_unit_cost_micro": 0,
      "tax_rate_bps": 0,
      "landed_unit_cost_micro": 0
    }
  ],
  "corrections": [
    {
      "id": 0,
      "number": "string",
      "reason": "string",
      "subtotal_before": 0,
      "subtotal_after": 0,
      "consumed_variance": 0,
      "lines": [
        {
          "goods_receipt_line_id": 0,
          "quantity_before": "string",
          "quantity_after": "string",
          "supplier_quantity_before": "string",
          "supplier_quantity_after": "string",
          "unit_cost_before": 0,
          "unit_cost_after": 0,
          "store_unit_cost_before_micro": 0,
          "store_unit_cost_after_micro": 0,
          "consumed_quantity": "string",
          "consumed_variance": 0
        }
      ],
      "created_at": "2026-01-15T12:00:00Z"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}