Квітанцыя

Готовыя да выкарыстання працоўныя патокі

01

Пачніце выкарыстоўваць Квітанцыю

Выкарыстоўвайце адмысловы токен API і пацвердзіце аперацыі чытання з дадзенымі тэсту спачатку.

Захоўвайце знак з боку сервера і адправіце яго ў заголоўку Authorization.
Праверце патрабаваныя параметры і пашырыць схему запыту або адказу.
Выкарыстоўвайце стан HTTP і стабільнае поле error ў памылках прыкладання.

GETАтрымаць квіты па парадку POSTСтварэнне квітанцыі для заказа GETАтрымаць квітанцыю

Мадэль дадзеных

Структуры дадзеных

Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.

Receipt14 палёў

idinteger · int64

Id.

read-only

clientIdinteger · int64

Ідэнтыфікатар кліента.

read-only

orderIdinteger · int64

Падпісанне па заказ.

read-only

organizationIdinteger · int64

Ід арганізацыі.

read-only

externalReceiptIdstring

Падпісанне знешняй атрымання.

fiscalNumberstring

Падатковы нумар.

cashRegisterServicestring

Паслуга рэгістрацыі грошай.

fnsUrlstring

Фнс Url.

statusstring

Status.

receiptTypestring

Тып квітанцыі.

totalAmountnumber · double

Агульная колькасць.

createdDatestring · date-time

Стварыўся Дата.

read-only

completedDatestring · date-time

Завяршылася дата.

errorMessagestring

Паведамленне памылкі.

Памылка дагавор

Як вяртаюць памылкі прыкладання

Код error аднолькавы ў кожным лакелі, у той час як паведамленне, якое з'яўляецца карыстальнікам, перакладаецца серверам.

error

Стабільны машыначытай код для інтэграцыйнай логікі.

localMessage

Паведамленне гатовае да адлюстравання на мове карыстальніка токены API.

params

Значэнні, якія інтэрполююцца серверам у лакалізаваным шаблоне паведамленняў.

文

localMessage выкарыстоўвае поле lang карыстальніка, які валодае токеном API. Мова дакументацыі і загаловак Accept-Language не змяняюць яго; руская выкарыстоўваецца, калі карыстацкая мова не канфігуруецца.

RUМясцовасць карыстальніка ru

{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}

BEБеларуская (be)

{
  "error": "error_brand_already_exists",
  "localMessage": "Брэнд Base ужо існуе",
  "params": {
    "name": "Base"
  }
}

Канчатковыя пункты

GET

Атрымаць квіты па парадку

/api/receipt/order/{orderId}

Значок з чытальным доступам

Атрымаць квітанцыі па замове з дапамогай GET /api/receipt/order/{orderId}.

Параметры шляху

Поле	Тып	Абавязкова	Апісанне
`orderId`	integer · int64	Так	Падпісанне па заказ.

curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/receipt/order/1001', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/receipt/order/1001', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/receipt/order/1001',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/receipt/order/1001',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/receipt/order/1001", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/receipt/order/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Удалы адказ

200

Структура элементаў масіва Receipt[]

Поле	Тып	Абавязкова	Апісанне
`id`	integer · int64	Не	Id.
`clientId`	integer · int64	Не	Ідэнтыфікатар кліента.
`orderId`	integer · int64	Не	Падпісанне па заказ.
`organizationId`	integer · int64	Не	Ід арганізацыі.
`externalReceiptId`	string	Не	Падпісанне знешняй атрымання.
`fiscalNumber`	string	Не	Падатковы нумар.
`cashRegisterService`	stringNONE, EVOTOR, ATOL	Не	Паслуга рэгістрацыі грошай.
`fnsUrl`	string	Не	Фнс Url.
`status`	stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED	Не	Status.
`receiptType`	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Не	Тып квітанцыі.
`totalAmount`	number · double	Не	Агульная колькасць.
`createdDate`	string · date-time	Не	Стварыўся Дата.
`completedDate`	string · date-time	Не	Завяршылася дата.
`errorMessage`	string	Не	Паведамленне памылкі.

[
  "string"
]

Памылкі3

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required

Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied

Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown

Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

POST

Стварэнне квітанцыі для заказа

/api/receipt/order/{orderId}

Знак з пісьмовым доступам

Стварэнне квітанцыі для замовы з дапамогай POST /api/receipt/order/{orderId}.

Параметры шляху

Поле	Тып	Абавязкова	Апісанне
`orderId`	integer · int64	Так	Падпісанне па заказ.

Параметры запытаў

Поле	Тып	Абавязкова	Апісанне
`type`Па змаўчанні: INCOME	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Не	Type.

curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/receipt/order/1001', {
  method: 'POST',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/receipt/order/1001', {
  method: 'POST',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.post(
    'https://api.selsup.ru/api/receipt/order/1001',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/receipt/order/1001',
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("POST", "https://api.selsup.ru/api/receipt/order/1001", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/receipt/order/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("POST", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Удалы адказ

200

Палі аб'ектаў Receipt

Поле	Тып	Абавязкова	Апісанне
`id`	integer · int64	Не	Id.
`clientId`	integer · int64	Не	Ідэнтыфікатар кліента.
`orderId`	integer · int64	Не	Падпісанне па заказ.
`organizationId`	integer · int64	Не	Ід арганізацыі.
`externalReceiptId`	string	Не	Падпісанне знешняй атрымання.
`fiscalNumber`	string	Не	Падатковы нумар.
`cashRegisterService`	stringNONE, EVOTOR, ATOL	Не	Паслуга рэгістрацыі грошай.
`fnsUrl`	string	Не	Фнс Url.
`status`	stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED	Не	Status.
`receiptType`	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Не	Тып квітанцыі.
`totalAmount`	number · double	Не	Агульная колькасць.
`createdDate`	string · date-time	Не	Стварыўся Дата.
`completedDate`	string · date-time	Не	Завяршылася дата.
`errorMessage`	string	Не	Паведамленне памылкі.

{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}

Памылкі3

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required

Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied

Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown

Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

GET

Атрымаць квітанцыю

/api/receipt/{receiptId}

Значок з чытальным доступам

Атрымаць квітанцыю з дапамогай GET /api/receipt/{receiptId}.

Параметры шляху

Поле	Тып	Абавязкова	Апісанне
`receiptId`	integer · int64	Так	Пазнак квітанцыі.

curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/receipt/1001', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/receipt/1001', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/receipt/1001',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/receipt/1001',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/receipt/1001", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/receipt/1001"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Удалы адказ

200

Палі аб'ектаў Receipt

Поле	Тып	Абавязкова	Апісанне
`id`	integer · int64	Не	Id.
`clientId`	integer · int64	Не	Ідэнтыфікатар кліента.
`orderId`	integer · int64	Не	Падпісанне па заказ.
`organizationId`	integer · int64	Не	Ід арганізацыі.
`externalReceiptId`	string	Не	Падпісанне знешняй атрымання.
`fiscalNumber`	string	Не	Падатковы нумар.
`cashRegisterService`	stringNONE, EVOTOR, ATOL	Не	Паслуга рэгістрацыі грошай.
`fnsUrl`	string	Не	Фнс Url.
`status`	stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED	Не	Status.
`receiptType`	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Не	Тып квітанцыі.
`totalAmount`	number · double	Не	Агульная колькасць.
`createdDate`	string · date-time	Не	Стварыўся Дата.
`completedDate`	string · date-time	Не	Завяршылася дата.
`errorMessage`	string	Не	Паведамленне памылкі.

{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}

Памылкі3

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required

Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied

Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown

Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

GET

Абноўленне статусу атрымання

/api/receipt/{receiptId}/update

Значок з чытальным доступам

Абноўленне стану атрымання з дапамогай GET /api/receipt/{receiptId}/update.

Параметры шляху

Поле	Тып	Абавязкова	Апісанне
`receiptId`	integer · int64	Так	Пазнак квітанцыі.

curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
  --header 'Authorization: YOUR_API_TOKEN'

const response = await fetch('https://api.selsup.ru/api/receipt/1001/update', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN },
});

if (!response.ok) {
  const error = await response.json();
  throw new Error(error.error || 'selsup_request_failed');
}

const result = await response.json();

const response: Response = await fetch('https://api.selsup.ru/api/receipt/1001/update', {
  method: 'GET',
  headers: { Authorization: process.env.SELSUP_API_TOKEN! },
});

if (!response.ok) {
  const error = await response.json() as { error?: string };
  throw new Error(error.error ?? 'selsup_request_failed');
}

const result: unknown = await response.json();

import os
import requests

response = requests.get(
    'https://api.selsup.ru/api/receipt/1001/update',
    headers={'Authorization': os.environ['SELSUP_API_TOKEN']},
)
response.raise_for_status()
result = response.json()

<?php

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.selsup.ru/api/receipt/1001/update',
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: ' . getenv('SELSUP_API_TOKEN')],
]);

$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

if ($response === false || $status >= 400) {
    throw new RuntimeException($response ?: 'selsup_request_failed');
}

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    req, err := http.NewRequest("GET", "https://api.selsup.ru/api/receipt/1001/update", nil)
    if err != nil { panic(err) }
    req.Header.Set("Authorization", os.Getenv("SELSUP_API_TOKEN"))

    response, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer response.Body.Close()
    result, _ := io.ReadAll(response.Body)
    fmt.Printf("%d\n%s\n", response.StatusCode, result)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class SelSupExample {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.selsup.ru/api/receipt/1001/update"))
            .header("Authorization", System.getenv("SELSUP_API_TOKEN"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode());
        System.out.println(response.body());
    }
}

Удалы адказ

200

Палі аб'ектаў Receipt

Поле	Тып	Абавязкова	Апісанне
`id`	integer · int64	Не	Id.
`clientId`	integer · int64	Не	Ідэнтыфікатар кліента.
`orderId`	integer · int64	Не	Падпісанне па заказ.
`organizationId`	integer · int64	Не	Ід арганізацыі.
`externalReceiptId`	string	Не	Падпісанне знешняй атрымання.
`fiscalNumber`	string	Не	Падатковы нумар.
`cashRegisterService`	stringNONE, EVOTOR, ATOL	Не	Паслуга рэгістрацыі грошай.
`fnsUrl`	string	Не	Фнс Url.
`status`	stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED	Не	Status.
`receiptType`	stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND	Не	Тып квітанцыі.
`totalAmount`	number · double	Не	Агульная колькасць.
`createdDate`	string · date-time	Не	Стварыўся Дата.
`completedDate`	string · date-time	Не	Завяршылася дата.
`errorMessage`	string	Не	Паведамленне памылкі.

{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}

Памылкі3

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required

Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied

Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown

Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

Готовыя да выкарыстання працоўныя патокі

Пачніце выкарыстоўваць Квітанцыю

Структуры дадзеных

Як вяртаюць памылкі прыкладання

Канчатковыя пункты

Атрымаць квіты па парадку

Параметры шляху

Удалы адказ

Стварэнне квітанцыі для заказа

Параметры шляху

Параметры запытаў

Удалы адказ

Атрымаць квітанцыю

Параметры шляху

Удалы адказ

Абноўленне статусу атрымання

Параметры шляху

Удалы адказ

Знак для запытаў на выпрабаванне

Рэальныя параметры запыту

Жывы адказ API