Drill-down from one payer to its periods, documents and accrual lines

GET /api/v1/billing/reports/payers/{id}

https://app.tanba-ooh.kz/api/v1/billing/reports/payers/{id}

Scope read:billing. The source of a line is its reference - an approval number, or a structure code with the hours of the plays.

Authentication

API key in the Authorization header, or a console session.

Scope: read:billing

Parameters

Name	In	Type	Required	Description	Example
`id`	path	string (uuid)	yes	Identifier of the payer.	`3a9d5e71-c4b2-4f08-b6d3-e8a1070c5f92`

Responses

200 The payer with its periods.

`application/json`

Name	Type	Required	Description	Example
`payer`	object	yes	The payer.
`periods`	array of object	yes	The periods of the payer with their documents and accrual lines.

Example

{
  "payer": {},
  "periods": [
    {}
  ]
}

Errors

Errors are problem documents (application/problem+json) with a stable code.

Status	Meaning
401	No valid session or API key (`unauthenticated`, `session_expired`, `invalid_api_key`).
403	The role or the key's scope does not allow this (`forbidden`, `key_scope_denied`, `key_route_denied`).
404	Nothing there, or not visible to the caller.
default	An error as a problem document.

Code samples

curl

curl 'https://app.tanba-ooh.kz/api/v1/billing/reports/payers/3a9d5e71-c4b2-4f08-b6d3-e8a1070c5f92' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Python

import requests

response = requests.get(
    "https://app.tanba-ooh.kz/api/v1/billing/reports/payers/3a9d5e71-c4b2-4f08-b6d3-e8a1070c5f92",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
    },
)
print(response.status_code, response.text)

package main

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

func main() {
	req, err := http.NewRequest("GET", "https://app.tanba-ooh.kz/api/v1/billing/reports/payers/3a9d5e71-c4b2-4f08-b6d3-e8a1070c5f92", 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))
}