SelSup Developers

El proyecto de ley de la Unión Europea · API Referencia

Recibo de la factura

Puntos finales para la recepción, incluidas las rutas exactas, los parámetros, los organismos de solicitud y los esquemas de respuesta expandibles.

4 puntos finales/api/receiptEstablesDescripción legible por máquina ↗
{ }

Esta página está respaldada por un contrato independiente editable. Valida las operaciones de escritura con datos de prueba antes de su uso en producción.

/api/receipt

Flujos de trabajo listos para su uso

Flujos de trabajo listos para su uso

01

Comience con el recibo

Utilice un token API dedicado y valida primero las operaciones de lectura con los datos de prueba.

  1. Mantenga el token en el lado del servidor y envíelo en el encabezado Authorization.
  2. Verifique los parámetros requeridos y amplíe el esquema de solicitud o respuesta.
  3. Manejar el estado HTTP y el campo estable error en errores de aplicación.

Modelo de datos

Estructuras de datos

Los modelos se enumeran una vez aquí y también se pueden ampliar directamente desde los puntos finales que los utilizan.

Receipt14 campos
idinteger · int64

Id.

read-only
clientIdinteger · int64

Identificación del cliente.

read-only
orderIdinteger · int64

El número de orden.

read-only
organizationIdinteger · int64

Identificación de la organización.

read-only
externalReceiptIdstring

Identificación de recibo externo.

fiscalNumberstring

Número fiscal.

cashRegisterServicestring

Servicio de registro de efectivo.

fnsUrlstring

¿Qué es lo que está pasando?

statusstring

Status.

receiptTypestring

Tipo de recibo.

totalAmountnumber · double

El importe total.

createdDatestring · date-time

Creado fecha.

read-only
completedDatestring · date-time

Fecha finalizada.

errorMessagestring

Mensaje de error.

Contrato de error

Cómo se devuelven los errores de aplicación

El código error es idéntico en todas las localizaciones, mientras que el mensaje orientado al usuario es traducido por el servidor.

Exproteccion

Código estable legible por máquina para la lógica de integración.

Exproteccion

Mensaje listo para la pantalla en el idioma del usuario de tokens API.

Exproteccion

Valores interpolados por el servidor en la plantilla de mensaje localizado.

localMessage utiliza el campo lang del usuario que posee el token API. El lenguaje de documentación y el encabezado Accept-Language no lo cambian; el ruso se utiliza cuando el usuario no tiene un idioma configurado.

RUEl lugar del usuario es ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
ESEspañol (es)
{
  "error": "error_brand_already_exists",
  "localMessage": "La marca Base ya existe",
  "params": {
    "name": "Base"
  }
}

Puntos finales

Puntos finales

GET

Obtenga recibos por orden

/api/receipt/order/{orderId}
Token con acceso a lectura

Obtenga recibos por orden usando GET /api/receipt/order/{orderId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
orderId integer · int64 El número de orden.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Estructura de los elementos del array Receipt[]
CampoTipoObligatorioDescripción
id integer · int64 No Id.
clientId integer · int64 No Identificación del cliente.
orderId integer · int64 No El número de orden.
organizationId integer · int64 No Identificación de la organización.
externalReceiptId string No Identificación de recibo externo.
fiscalNumber string No Número fiscal.
cashRegisterService stringNONE, EVOTOR, ATOL No Servicio de registro de efectivo.
fnsUrl string No ¿Qué es lo que está pasando?
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Tipo de recibo.
totalAmount number · double No El importe total.
createdDate string · date-time No Creado fecha.
completedDate string · date-time No Fecha finalizada.
errorMessage string No Mensaje de error.
[
  "string"
]
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

POST

Crear recibo para el pedido

/api/receipt/order/{orderId}
Token con acceso a escribir

Crea recibo para pedidos usando POST /api/receipt/order/{orderId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
orderId integer · int64 El número de orden.

Parámetros de consulta

CampoTipoObligatorioDescripción
typeValor predeterminado: INCOME stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Campos de objetos Receipt
CampoTipoObligatorioDescripción
id integer · int64 No Id.
clientId integer · int64 No Identificación del cliente.
orderId integer · int64 No El número de orden.
organizationId integer · int64 No Identificación de la organización.
externalReceiptId string No Identificación de recibo externo.
fiscalNumber string No Número fiscal.
cashRegisterService stringNONE, EVOTOR, ATOL No Servicio de registro de efectivo.
fnsUrl string No ¿Qué es lo que está pasando?
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Tipo de recibo.
totalAmount number · double No El importe total.
createdDate string · date-time No Creado fecha.
completedDate string · date-time No Fecha finalizada.
errorMessage string No Mensaje de error.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

GET

Obtenga el recibo

/api/receipt/{receiptId}
Token con acceso a lectura

Obtenga el recibo utilizando GET /api/receipt/{receiptId}.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
receiptId integer · int64 Identificación de recibo.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Campos de objetos Receipt
CampoTipoObligatorioDescripción
id integer · int64 No Id.
clientId integer · int64 No Identificación del cliente.
orderId integer · int64 No El número de orden.
organizationId integer · int64 No Identificación de la organización.
externalReceiptId string No Identificación de recibo externo.
fiscalNumber string No Número fiscal.
cashRegisterService stringNONE, EVOTOR, ATOL No Servicio de registro de efectivo.
fnsUrl string No ¿Qué es lo que está pasando?
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Tipo de recibo.
totalAmount number · double No El importe total.
createdDate string · date-time No Creado fecha.
completedDate string · date-time No Fecha finalizada.
errorMessage string No Mensaje de error.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

GET

Actualización del estado de recibo

/api/receipt/{receiptId}/update
Token con acceso a lectura

Actualización del estado de recibo usando GET /api/receipt/{receiptId}/update.

Parámetros de trayectoria

CampoTipoObligatorioDescripción
receiptId integer · int64 Identificación de recibo.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
  --header 'Authorization: YOUR_API_TOKEN'

Respuesta exitosa

200
Campos de objetos Receipt
CampoTipoObligatorioDescripción
id integer · int64 No Id.
clientId integer · int64 No Identificación del cliente.
orderId integer · int64 No El número de orden.
organizationId integer · int64 No Identificación de la organización.
externalReceiptId string No Identificación de recibo externo.
fiscalNumber string No Número fiscal.
cashRegisterService stringNONE, EVOTOR, ATOL No Servicio de registro de efectivo.
fnsUrl string No ¿Qué es lo que está pasando?
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED No Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND No Tipo de recibo.
totalAmount number · double No El importe total.
createdDate string · date-time No Creado fecha.
completedDate string · date-time No Fecha finalizada.
errorMessage string No Mensaje de error.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Errores3

Los errores de aplicación se devuelven normalmente como JSON con error, localMessage y params. Cómo se devuelven los errores de aplicación ↑

401auth_required
Se requiere la autenticación

Authorization está faltando, vacío o contiene un token inválido.

400error_access_denied
Acceso denegado

El token existe, pero su papel no puede realizar esta operación.

500error_unknown
Ocurrió un error desconocido. Si el problema persiste, escriba al servicio de soporte

Fallo interno: ahorra tiempo en la solicitud y apoyo de contacto; no vuelva a intentar una mutación ciegamente.

Authorization

Token para las solicitudes de ensayo

El token se queda en el localStorage de este navegador y se envía solo en el encabezado Authorization de las solicitudes a api.selsup.ru.

Probar

Parámetros reales de la solicitud

Respuesta en vivo API

Envía una solicitud para ver la respuesta SelSup.