API

Iegūt darījumu sarakstu

GET/api/crm/v2/transactionsv2
operationId: transactions.default

Autorizācija

api-token + language + role

Vaicājuma parametri

page_numberinteger

Piemērs: 1

date_fromstring

Piemērs: 25/04/2024

date_tostring

Piemērs: 26/04/2024

account_idinteger
chain_idinteger
branch_idinteger
city_idinteger
platforminteger
order_numberinteger
downloadstring

Vērtības:yes

Piemērs: yes

Atbildes

OK

object
statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_toobject (FilterDateTo)
valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_rangeobject (FilterDateRange)

Gatavi datuma filtra periodi; apakšējā robeža tiek aprēķināta lietotāja laika joslā. value — periods, kuram atbilst pašreizējie *_from un *_to; null — patvaļīgs periods. default — periods, kuru serveris izmanto pieprasījumā bez datumiem: tas tiek piemērots arī sadaļas pirmajā ielādē un pie atiestatīšanas. Perioda augšējā robeža vienmēr ir vienāda ar lietotāja pašreizējo dienu, tāpēc option to nesatur: gatavam periodam nav jānosūta *_to, serveris to iestata pats. Periods, kas ir garāks par gadu, tiek apgriezts no svaigākās robežas puses.

valuestring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

defaultstring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

typestringobligāts

Piemērs: select

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

optionarray of objectobligāts
valuestring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

date_fromstringobligāts

Piemērs: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

platformobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

order_numberobject (FilterId)
valueany

Piemērs: 0

typestringobligāts

Piemērs: integer

placeholderstring

Piemērs: integer

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

downloadobject (FilterButtonDownloadCsv)

Lejupielādes poga: nospiežot, pārsūtiet download=yes

valuestring

Piemērs: Download

typestringobligāts

Piemērs: button_download_csv

listarray of object
statusstringobligāts

Transakcijas statuss: confirmed vai refunded

Vērtības:confirmedrefunded

Piemērs: confirmed

datestring (DataTimeFormatSQL) obligāts

Piemērs: 2024-05-02 08:31:16

sumnumberobligāts

Piemērs: 256.15

transaction_internal_idintegerobligāts

Piemērs: 149882001

transaction_external_idanyobligāts

Piemērs: 149882001

branch_idintegerobligāts

Piemērs: 8783

namestringobligāts

Piemērs: Test

phone_format_idintegerobligāts

Piemērs: 2

phone_numberstringobligāts

Piemērs: 98489046

order_numberinteger

Piemērs: 96

platformstring (Platform) obligāts

Vērtības:androidiosallmobile_appssitesocial_apps

Piemērs: all

city_namestringobligāts

Piemērs: Voronezh

branch_namestringobligāts

Piemērs: Green Basket | Main

chain_namestringobligāts

Piemērs: Green Basket

payment_namestringobligāts

Piemērs: Telcell

paginationobject (Pagination)
max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: false