Cette page est soutenue par un contrat indépendant éditable. Valider les opérations de rédaction avec des données de test avant utilisation de production.
/api/receipt
Flux de travail prêts à l'emploi
Flux de travail prêts à l'emploi
01
Commencez à utiliser le reçu
Utilisez un jeton API dédié et validez d'abord les opérations de lecture avec les données de test.
Gardez le jeton côté serveur et envoyez-le dans l'en-tête Authorization.
Vérifiez les paramètres requis et élargissez le schéma de demande ou de réponse.
Traiter l'état HTTP et le champ stable error dans les erreurs d'application.
Les modèles sont énumérés une fois ici et peuvent également être étendus directement depuis les terminaux qui les utilisent.
Receipt14 champs
idinteger · int64
Id.
read-only
clientIdinteger · int64
Nom du client.
read-only
orderIdinteger · int64
Nom de commande.
read-only
organizationIdinteger · int64
Identification de l'organisation.
read-only
externalReceiptIdstring
Identification de réception externe.
fiscalNumberstring
Numéro fiscal.
cashRegisterServicestring
Le service de l'enregistrement des espèces.
fnsUrlstring
Je suis en train de vous dire.
statusstring
Status.
receiptTypestring
Type de reçu.
totalAmountnumber · double
Montant total.
createdDatestring · date-time
Date créée.
read-only
completedDatestring · date-time
Date de finition.
errorMessagestring
Message d'erreur.
Contrats d'erreur
Comment les erreurs d'application sont retournées
Le code error est identique dans chaque locale, tandis que le message d'utilisateur est traduit par le serveur.
Le projet de loi
Code stable lisible par machine pour la logique d'intégration.
Le projet de loi
Message prêt à être affiché dans la langue de l'utilisateur de jeton API.
Le projet de loi
Les valeurs interpolées par le serveur dans le modèle de message localisé.
文
localMessage utilise le champ lang de l'utilisateur qui possède le jeton API. Le langage de documentation et l'en-tête Accept-Language ne le modifient pas; le russe est utilisé lorsque l'usager n'a pas de langue configurée.
RULocalisation de l'utilisateur est ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
FRFrançais (fr)
{
"error": "error_brand_already_exists",
"localMessage": "La marque Base existe déjà",
"params": {
"name": "Base"
}
}
Les points de fin
Les points de fin
GET
Obtenez des reçus par ordre
/api/receipt/order/{orderId}
Token avec accès à la lecture
Obtenez des reçus par commande à l'aide de GET /api/receipt/order/{orderId}.
Parametres de parcours
Champ
Type
Obligatoire
Description
orderId
integer · int64
Oui
Nom de commande.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
401auth_required
Autentification requise
Authorization est manquant, vide ou contient un jeton non valide.
400error_access_denied
Accès refusé
Le jeton existe, mais son rôle ne peut pas effectuer cette opération.
500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance
Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
POST
Créer un reçu pour la commande
/api/receipt/order/{orderId}
Token avec accès à l'écriture
Créer un reçu pour commande à l'aide de POST /api/receipt/order/{orderId}.
Parametres de parcours
Champ
Type
Obligatoire
Description
orderId
integer · int64
Oui
Nom de commande.
Paramètres de requête
Champ
Type
Obligatoire
Description
typeValeur par défaut: INCOME
stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND
Non
Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
401auth_required
Autentification requise
Authorization est manquant, vide ou contient un jeton non valide.
400error_access_denied
Accès refusé
Le jeton existe, mais son rôle ne peut pas effectuer cette opération.
500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance
Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
GET
Obtenez le reçu
/api/receipt/{receiptId}
Token avec accès à la lecture
Obtenez le reçu à l'aide de GET /api/receipt/{receiptId}.
Parametres de parcours
Champ
Type
Obligatoire
Description
receiptId
integer · int64
Oui
Le reçu.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
401auth_required
Autentification requise
Authorization est manquant, vide ou contient un jeton non valide.
400error_access_denied
Accès refusé
Le jeton existe, mais son rôle ne peut pas effectuer cette opération.
500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance
Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.
GET
Mise à jour du statut de réception
/api/receipt/{receiptId}/update
Token avec accès à la lecture
Mise à jour de l'état de la réception à l'aide de GET /api/receipt/{receiptId}/update.
Parametres de parcours
Champ
Type
Obligatoire
Description
receiptId
integer · int64
Oui
Le reçu.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
--header 'Authorization: YOUR_API_TOKEN'
Les erreurs d'application sont normalement renvoyées sous le nom JSON avec error, localMessage et params. Brancher sur XPRO TECTED4X; le texte localisé peut changer. Comment les erreurs d'application sont retournées ↑
401auth_required
Autentification requise
Authorization est manquant, vide ou contient un jeton non valide.
400error_access_denied
Accès refusé
Le jeton existe, mais son rôle ne peut pas effectuer cette opération.
500error_unknown
Une erreur inconnue s'est produite. Si le problème persiste, contactez le service d'assistance
Faillite interne: économiser le temps de la demande et le support de contact; ne réessayez pas aveuglément une mutation.