Modul Invoice

Komenda: activateById

Opis komendy
Komenda pozwala na aktywowanie wniosków.

Parametry

 

Parametr Opis
wnId numer aktywowanego wniosku

 

Zwracane dane

 

Zwracane dane Opis
successItems aktywowane pozycje z wniosku
failureItems nieaktywowane pozycje z wniosku
wnId numer nowego wniosku dla pozycji, dla których usługi nie zostały aktywowane

 

Przykładowa komenda
activateById(„1234567”)

1
$response = $soap->activateById("1234567");

Przykładowa odpowiedź:

1
{"status":true,"successItems":["test.pl"],"failureItems":["nieudanytest.pl"],"wnId":"12348888"}

Komenda: sendRemind

Opis komendy
Komenda pozwala na ponowne wysłanie wniosku do abonenta CSA.

Parametry

 

Parametr Opis
wnId numer wysyłanego wniosku
email adres email, na który ma zostać wysłany wniosek

 

Zwracane dane

 

Zwracane dane Opis
isSend Status wysyłki – nieudana (0) lub udana (1)

 

Przykładowa komenda
sendRemind(‚123456′,’test@hrd.pl’)

1
$response = $soap->sendRemind('123456','test@hrd.pl');

Przykładowa odpowiedź:

1
{"status":true,"isSend":1}

Komenda: info

Opis komendy
Komenda pozwala na pobranie informacji o wniosku.
Tablica danych dla poszczególnych pozycji zwracana jest w tablicy „items”.

Parametry

 

Parametr Opis
wnID Numer ID sprawdzanego wniosku

 

Zwracane dane

 

Zwracane dane Opis
Dane podawane są dla każdej pozycji z wniosku z podaniem id pozycji
itemId numer pozycji (numer wniosku)
item nazwa domeny
period okres utrzymania
service nazwa usługi
clientPrice cena dla klienta
price cena zakupu; podsumowanie: numer konta klienta
Dane sumaryczne dla całego wniosku
price cena zakupu
clientPrice cena dla klienta
crDate data utworzenia wniosku
exDate termin płatności wniosku
invoiceStatus status wniosku (unpaid lub paid)

 

Przykładowa komenda
info(‚123456’)

1
$response = $soap->info('123456');

Przykładowa odpowiedź:

1
{"status":true,"items":{"12345089":{"item":"asfdfsfd.pl","period":"1 y","service":"rejestracja","clientPrice":"19.9","price":"10"},"12345090":{"item":"afdadfaf.com.pl","period":"1 y","service":"rejestracja","clientPrice":"8","price":"8"}},"client":"csaXXX","price":18,"clientPrice":27.9,"crDate":"2012-11-15 16:47:49","exDate":"2012-11-25 00:00:00","invoiceStatus":"unpaid"}

Komenda: infoByDomain

Opis komendy
Komenda pozwala na pobranie informacji o wniosku na podstawie nazwy domeny.
Tablica danych dla poszczególnych pozycji zwracana jest w tablicy „items”.

Parametry

 

Parametr Opis
domain nazwa domeny występująca w wniosku

 

Zwracane dane

 

Zwracane dane Opis
Dane podawane są dla każdej pozycji z wniosku z podaniem id pozycji
itemId numer pozycji (numer wniosku)
item nazwa domeny
period okres utrzymania
service nazwa usługi
clientPrice cena dla klienta
price cena zakupu; podsumowanie: numer konta klienta
Dane sumaryczne dla całego wniosku
price cena zakupu
clientPrice cena dla klienta
crDate data utworzenia wniosku
exDate termin płatności wniosku
invoiceStatus status wniosku (unpaid lub paid)

 

Przykładowa komenda
infoByDomain(‚asfdfsfd.pl’)

1
$response = $soap->infoByDomain('asfdfsfd.pl');

Przykładowa odpowiedź:

1
{"status":true,"items":{"12345089":{"item":"asfdfsfd.pl","period":"1 y","service":"rejestracja","clientPrice":"19.9","price":"10"},"12345090":{"item":"afdadfaf.com.pl","period":"1 y","service":"rejestracja","clientPrice":"8","price":"8"}},"client":"csaXXX","price":18,"clientPrice":27.9,"crDate":"2012-11-15 16:47:49","exDate":"2012-11-25 00:00:00","invoiceStatus":"unpaid"}

Komenda: listByClient

Opis komendy
Komenda zwraca listę wniosków klienta z limitem 100 wniosków na komendę; przesunięcie pozwala na wyświetlenie kolejnych wniosków z konta klienta.

Parametry

 

Parametr Opis
Numer CSA numer konta abonenckiego CSA, dla którego wygenerowana zostanie lista wniosków
offset przesunięcie pozwalające na wyświetlenie kolejnych wniosków z konta klienta

 

Zwracane dane

 

Zwracane dane Opis
max ilość wniosków abonenta
invoices tablica numerów wniosków oddzielonych przecinkami

 

Przykładowa komenda
listByClient(„csa1234”, 0)

1
$response = $soap->listByClient("csa1234", 0);

Przykładowa odpowiedź:

1
{"status":true,"max":"2","invoices":["12313184","12313186"]}

Komenda: listAll

Opis komendy
Komenda zwraca listę wniosków wygenerowanych w koncie Partnera z limitem 100 wniosków na komendę; przesunięcie pozwala na wyświetlenie kolejnych wniosków z konta.

Parametry

 

Parametr Opis
offset przesunięcie pozwalające na wyświetlenie kolejnych wniosków z konta klienta

 

Zwracane dane

 

Zwracane dane Opis
max ilość wniosków wygenerowanych w koncie Partnera
invoices tablica numerów wniosków oddzielonych przecinkami

 

Przykładowa komenda
listAll(100)

1
$response = $soap->listAll(100);

Przykładowa odpowiedź:

1
{"status":true,"max":"104","invoices":["123456","1245855","12548745","4545664"]}