Квитанция

Қолдануға дайын жұмыс барысы

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

Сыртқы квитанция ID.

fiscalNumberstring

Салықтық сан.

cashRegisterServicestring

Ақша тіркелгі қызметі.

fnsUrlstring

ФНС URL.

statusstring

Status.

receiptTypestring

Квитанция түрі.

totalAmountnumber · double

Жалпы сома.

createdDatestring · date-time

Жасау күні.

read-only

completedDatestring · date-time

Аяқталған күн.

errorMessagestring

Қате хабарламасы.

Қате туралы келісімшарт

Қолданба қателерін қайтару

error коды барлық жерлерде бірдей, ал пайдаланушымен бетпе-бет сөйлейтін хабарлама сервер арқылы аударылады. error-ге арналған қолданба логикасын құру және localMessage-ді көрсету үшін ғана пайдалану.

error

Интеграциялық логика үшін тұрақты машина оқуға болатын код.

localMessage

API белгі пайдаланушы тілінде көрсетілуге дайын хабарлама.

params

Сервердің жергілікті хабарлама үлгісіне интерполациялаған мәндері.

文

localMessage API белгісін иеленуші пайдаланушының lang өрісін пайдаланады. Құжаттама тілі мен Accept-Language баған оны өзгертпейді; орыс тілі пайдаланушының тілі конфигурацияланбаған кезде қолданылады.

RUПайдаланушы жері ru

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

KKҚазақша (kk)

{
  "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	Жоқ	Сыртқы квитанция ID.
`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 және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

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	Жоқ	Сыртқы квитанция ID.
`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 және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required

Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied

Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown

Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

GET