TAŇBA-OOH Әзірлеушілерге

One money report section as CSV

GET /api/v1/exports/billing-reports/{name}

https://app.tanba-ooh.kz/api/v1/exports/billing-reports/{name}

Анықтамалықтың техникалық мәтіні ағылшын тілінде жазылған.

Scope read:billing. Sections are months, issuers, payers, kinds, districts, overdue, ageing and cash-calendar.

Аутентификация

Authorization тақырыбындағы API кілті немесе консоль сеансы.

Рұқсат: read:billing

Параметрлер

АтауыОрныТүріМіндеттіСипаттамаМысал
nameжолstringиәSection of the money report to download. months, issuers, payers, kinds, districts, overdue, ageing, cash-calendarmonths
fromсұрауstringжоқFirst month, YYYY-MM.2025-11
toсұрауstringжоқLast month, YYYY-MM.2026-10
sepсұрауstringжоқColumn separator; semicolon for spreadsheets set to a comma decimal mark. comma, semicoloncomma

Жауаптар

200 UTF-8 CSV with a byte-order mark and a header row.

text/csv

Мысал

string

Қателер

Қателер problem құжаты (application/problem+json) түрінде, тұрақты code өрісімен келеді.

МәртебесіМағынасы
401No valid session or API key (unauthenticated, session_expired, invalid_api_key).
403The role or the key's scope does not allow this (forbidden, key_scope_denied, key_route_denied).
404Nothing there, or not visible to the caller.
422Field errors (validation_failed).
defaultAn error as a problem document.

Код мысалдары

curl

curl 'https://app.tanba-ooh.kz/api/v1/exports/billing-reports/months' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Python
import requests

response = requests.get(
    "https://app.tanba-ooh.kz/api/v1/exports/billing-reports/months",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
    },
)
print(response.status_code, response.text)
Go
package main

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

func main() {
	req, err := http.NewRequest("GET", "https://app.tanba-ooh.kz/api/v1/exports/billing-reports/months", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}