Datos fiscales de clientes

Datos fiscales con los que se emiten los comprobantes de los pedidos nuevos del cliente.

Cargando el índice de búsqueda…

Datos fiscales de clientes

Objetos

CustomerFiscalProfile

  • customer_idintegerobligatorio

    ID del cliente.

  • receptorobject o nullobligatorio

    Datos fiscales con los que se emiten los comprobantes de los pedidos nuevos; null — un cliente minorista sin datos fiscales. Un pedido ya confirmado guarda su propia copia (fiscal_receptor del pedido).

    Campos · 5
    • id_typestringobligatorio

      Tipo de identificación: tax_id — CUIT de una empresa; personal_id — CUIL de una persona; national_id — DNI; passport — pasaporte; none — sin identificación.

      Valores:
      tax_idpersonal_idnational_idpassportnone
    • id_numberstring o nullobligatorio

      Número de la identificación; null cuando id_type es none.

    • namestring o nullobligatorio

      Razón social o nombre completo para el comprobante; null si no se indicó.

    • tax_statusstringobligatorio

      Condición frente al IVA: registered — Responsable Inscripto; small_taxpayer — Monotributo; exempt — exento; final_consumer — consumidor final; not_categorized — no categorizado; foreign — cliente del exterior.

      Valores:
      registeredsmall_taxpayerexemptfinal_consumernot_categorizedforeign
    • addressstring o nullobligatorio

      Domicilio fiscal en una línea; null si no se indicó.

Endpoints

Obtener los datos fiscales de un cliente

get/customers/{customer}/fiscal-profile

Scope: customers:read

Parámetros

Ruta

  • customerintegerobligatorio

    ID del cliente.

Respuestas

200Éxito

Encabezados

  • ETagstringobligatorio

    Versión del registro. Mandala en If-Match para cambiar el registro.

    Ejemplo:
    "7"

application/json

Devuelve CustomerFiscalProfile

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/customers/{customer}/fiscal-profile" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "customer_id": 0,
  "receptor": {
    "id_type": "tax_id",
    "id_number": "string",
    "name": "string",
    "tax_status": "registered",
    "address": "string"
  }
}

Reemplazar los datos fiscales de un cliente; null lo vuelve consumidor sin datos fiscales

put/customers/{customer}/fiscal-profile

Scope: customers:write

Parámetros

Ruta

  • customerintegerobligatorio

    ID del cliente.

Encabezado

  • Idempotency-Keystring

    Clave única del intento, por ejemplo un UUID. Un reintento con la misma clave y el mismo cuerpo recibe la respuesta guardada en vez de escribir dos veces. Las claves duran 24 horas.

    Largo mínimo:
    1
    Largo máximo:
    255
    Ejemplo:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringobligatorio

    ETag del registro de la última lectura, por ejemplo "7". El cambio se aplica solo si nadie cambió el registro desde entonces; si no, 412. Sin él, 428.

    Ejemplo:
    "7"

Cuerpo de la solicitud application/json

  • receptorobject o nullobligatorio

    Datos fiscales con los que se emiten los comprobantes de los pedidos nuevos; null — un cliente minorista sin datos fiscales. Un pedido ya confirmado guarda su propia copia (fiscal_receptor del pedido).

    Campos · 5
    • id_typestring

      Tipo de identificación: tax_id — CUIT de una empresa; personal_id — CUIL de una persona; national_id — DNI; passport — pasaporte; none — sin identificación.

      Valores:
      tax_idpersonal_idnational_idpassportnone
    • id_numberstring o null

      Número de la identificación; null cuando id_type es none.

      Largo máximo:
      32
    • namestring o null

      Razón social o nombre completo para el comprobante; null si no se indicó.

      Largo máximo:
      255
    • tax_statusstring

      Condición frente al IVA: registered — Responsable Inscripto; small_taxpayer — Monotributo; exempt — exento; final_consumer — consumidor final; not_categorized — no categorizado; foreign — cliente del exterior.

      Valores:
      registeredsmall_taxpayerexemptfinal_consumernot_categorizedforeign
    • addressstring o null

      Domicilio fiscal en una línea; null si no se indicó.

      Largo máximo:
      255

Respuestas

200Éxito

Encabezados

  • Idempotent-Replayedstring

    true cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.

    Valores:
    true
  • ETagstringobligatorio

    Versión del registro. Mandala en If-Match para cambiar el registro.

    Ejemplo:
    "7"

application/json

Devuelve CustomerFiscalProfile

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

409Hay una solicitud en curso con la misma clave de idempotencia, los datos cambiaron después de leerlos, el ID externo pertenece a otro registro, se alcanzó el límite del plan o de endpoints de webhook, o el cambio necesita consentir sus consecuencias

Encabezados

  • Retry-Afterinteger

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve ConflictProblem

412El registro cambió después de leerlo: la versión de If-Match no es la actual

application/problem+json

Devuelve Problem

422Un parámetro es inválido o desconocido

application/problem+json

Devuelve ValidationProblem

428La solicitud necesita If-Match con el ETag del registro

application/problem+json

Devuelve Problem

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 -X PUT "https://api.saleya.app/v1/customers/{customer}/fiscal-profile" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Cuerpo de la solicitud — body.json
{
  "receptor": {
    "id_type": "tax_id",
    "id_number": "string",
    "name": "string",
    "tax_status": "registered",
    "address": "string"
  }
}
Ejemplo de respuesta · 200
{
  "customer_id": 0,
  "receptor": {
    "id_type": "tax_id",
    "id_number": "string",
    "name": "string",
    "tax_status": "registered",
    "address": "string"
  }
}