Sąskaitų sąrašas per API

Sąskaitų sąrašo gavimas per API

Gaukite veiklos dokumentus pagal išrašymo datos intervalą.

POSThttps://www.saskaitos.lt/apitype: bill

1$config = [2    'apiKey'    => 'JUSU_API_RAKTAS',3    'companyId' => 1,4];5 6$listParams = [7    'type'   => 'bill',8    'action' => 'list',9    'Filter' => [10        'DateFrom' => '2026-10-01',11        'DateTo'   => '2026-10-31',12    ],13];14 15$respondList = json_decode(UseCURLSocket(16    'https://www.saskaitos.lt/api',17    array_merge($config, $listParams)18));

$config = [
    'apiKey'    => 'JUSU_API_RAKTAS',
    'companyId' => 1,
];

$listParams = [
    'type'   => 'bill',
    'action' => 'list',
    'Filter' => [
        'DateFrom' => '2026-10-01',
        'DateTo'   => '2026-10-31',
    ],
];

$respondList = json_decode(UseCURLSocket(
    'https://www.saskaitos.lt/api',
    array_merge($config, $listParams)
));

POST · formos duomenysJSON atsakymas

Pavyzdyje naudojama UseCURLSocket() funkcija. Jos aprašymas yra pilname PHP API pavyzdyje.

LAUKŲ ŽINYNAS

Laukai, tipai ir galimos reikšmės

Žemiau – šio PHP pavyzdžio parametrai ir paaiškinimas, ką juose perduoti.

stringTekstas, pvz. vardas ar įmonės kodas.

intSkaitinis ID, pavyzdyje sveikasis skaičius.

arraySusijusių laukų arba reikšmių masyvas.

PHP masyvai perduodami POST formos laukais, pvz. Filter[DateFrom]. Užklausos reikšmės perduodamos tekstu, atsakymas grąžinamas JSON.

apiKeystring

Jūsų veiklos API raktas.

Bent 10 simbolių. Naudokite savo veiklos nustatymuose esantį raktą.

'JUSU_API_RAKTAS'Privalomas

companyIdint

Veiklos, kurios vardu atliekate veiksmą, numeris.

Teigiamas veiklos ID, pavyzdyje 1.

1Privalomas

typestring

API duomenų sritis.

Sąskaitų dokumentų sričiai naudokite 'bill'.

'bill'Privalomas šiame pavyzdyje

actionstring

Sąrašo gavimo veiksmas.

Naudokite 'list'.

'list'Privalomas šiame pavyzdyje

Filterarray

Datos intervalo filtrų grupė.

Asociatyvus PHP masyvas su DateFrom ir DateTo; POST laukai Filter[DateFrom] ir Filter[DateTo].

[...]Duomenų grupė

Filter.DateFromstring

Laikotarpio pradžia pagal dokumento išrašymo datą.

Rekomenduojamas formatas YYYY-MM-DD. Intervalas prasideda šios dienos 00:00:00.

'2026-10-01'Privalomas

Filter.DateTostring

Laikotarpio pabaiga pagal dokumento išrašymo datą.

Rekomenduojamas formatas YYYY-MM-DD. Intervalas baigiasi šios dienos 23:59:59.

'2026-10-31'Privalomas

Galimos action reikšmės

listGauti sąrašą

Perduokite Filter.DateFrom ir Filter.DateTo; rezultatai grąžinami Bills masyve.

Intervalas apima abi nurodytas dienas. Grąžinami ne daugiau kaip 500 dokumentų, rikiuojant nuo naujausios išrašymo datos. Didesniam laikotarpiui skaidykite užklausas į mažesnius intervalus. Atskiro puslapiavimo parametro nėra.

Jei dokumentų nėra, atsakymo Bills masyvas yra tuščias. Šis pavyzdys naudoja datos filtrus; klientas, būsena ir dokumento rūšis šiame veiksme papildomai nefiltruojami.

Sąskaitų sąrašas

Sąskaitų sąrašo gavimas per API

Galimos action reikšmės

Sąskaita klientui greičiau ir tvarkingiau