Datos fiscales de clientes
Datos fiscales con los que se emiten los comprobantes de los pedidos nuevos del cliente.
Datos fiscales de clientes
Objetos
CustomerFiscalProfile
customer_idintegerobligatorioID del cliente.
receptorobject o nullobligatorioDatos 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_typestringobligatorioTipo 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 nullobligatorioNúmero de la identificación; null cuando id_type es none.
namestring o nullobligatorioRazón social o nombre completo para el comprobante; null si no se indicó.
tax_statusstringobligatorioCondició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 nullobligatorioDomicilio 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
customerintegerobligatorioID del cliente.
Respuestas
200Éxito
Encabezados
ETagstringobligatorioVersió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-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos 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
curl "https://api.saleya.app/v1/customers/{customer}/fiscal-profile" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"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
customerintegerobligatorioID del cliente.
Encabezado
Idempotency-KeystringClave ú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-MatchstringobligatorioETag 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 nullobligatorioDatos 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_typestringTipo 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 nullNúmero de la identificación; null cuando id_type es none.
- Largo máximo:
- 32
namestring o nullRazón social o nombre completo para el comprobante; null si no se indicó.
- Largo máximo:
- 255
tax_statusstringCondició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 nullDomicilio fiscal en una línea; null si no se indicó.
- Largo máximo:
- 255
Respuestas
200Éxito
Encabezados
Idempotent-Replayedstringtrue cuando es la respuesta guardada de una solicitud anterior con el mismo Idempotency-Key.
- Valores:
true
ETagstringobligatorioVersió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-AuthenticatestringobligatorioEsquema 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-AuthenticatestringEsquema 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-AfterintegerSegundos 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-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
- 409
idempotency_key_in_useHay una solicitud en curso con esta clave - 412
precondition_failedEl registro cambió - 422
idempotency_key_reusedLa clave de idempotencia ya se usó - 422
invalid_idempotency_keyLa clave de idempotencia no es válida - 428
precondition_requiredFalta If-Match
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
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{
"receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
}
}{
"customer_id": 0,
"receptor": {
"id_type": "tax_id",
"id_number": "string",
"name": "string",
"tax_status": "registered",
"address": "string"
}
}