Dodanie płatności metoda: /api/payment/add/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | cdate | datetime | Data utworzenia płatności | Pole nie wymagane. | Jeżeli nie określono, zostanie wprowadzona bieżąca data. |
4 | pdate | datetime | Data realizacji (kiedy płatność stała się aktywna) | Pole nie wymagane. | |
5 | rdate | datetime | Data odmowy płatności | Pole nie wymagane. | |
6 | sum | float | Kwota płatności | Pole obowiązkowe. | Nie może być równe 0 |
7 | sumbase | float | Kwota płatności w walucie bazowej | Pole nie wymagane. | Jest to kwota w walucie bazowej systemu OneBox (jeżeli jej nie określisz, system automatycznie uzupełni ją na podstawie kwoty płatności) |
8 | currencyid | integer | ID waluta płatności | Pole nie wymagane. | |
9 | currencyname | string | Nazwa waluty płatności | Pole nie wymagane. | |
10 | currencyrate | float | Kurs wymiany waluty płatności w stosunku do waluty bazowej systemu | Pole nie wymagane. | |
11 | accountid | integer | ID Konta, na które należy dokonywać płatności w systemie | Pole nie wymagane. | |
12 | accountname | string | Nazwa rachunku, na który należy dokonać płatności w systemie | Pole nie wymagane. | |
13 | accountcode1c | string | Zewnętrzny identyfikator rachunku, na który należy dokonywać płatności w systemie | Pole nie wymagane. | |
14 | clientid | integer | id klient dla którego utworzyć płatność | Pole nie wymagane. | Jeśli to określisz, system spróbuje znaleźć klienta po identyfikatorze i powiązać z nim płatność |
15 | clientcode1c | string | code1c klient dla którego utworzyć płatność | Pole nie wymagane. | Jeśli określisz, system spróbuje znaleźć klienta za pomocą code1c i powiązać z nim płatność |
16 | clientemail | string | Email klient dla którego utworzyć płatność | Pole nie wymagane. | Jeśli tak określisz, system spróbuje znaleźć klienta poprzez e-mail i powiązać z nim płatność |
17 | clientphone | string | Numer telefonu klienta, na który należy dokonać płatności | Pole nie wymagane. | Jeśli to określisz, system spróbuje znaleźć klienta telefonicznie i powiązać z nim płatność |
18 | codepayment | string | Kod płatności | Pole nie wymagane. | |
19 | clientname | string | Nazwa klienta dla którego tworzysz płatność | Pole nie wymagane. | |
20 | managerid | integer | id użytkownika, który dokona płatności | Pole nie wymagane. | Jeśli nie określisz, zostanie pobrany użytkownik, od którego zostanie utworzona płatność |
21 | categoryid | interger | Id kategorie płatności | Pole nie wymagane. | |
22 | categoryname | string | Nazwa kategorii płatności | Pole nie wymagane. | |
23 | orderid | integer | Id zamówienie, do którego należy dołączyć płatność | Pole nie wymagane. | Jeśli to określisz, system spróbuje znaleźć zamówienie według identyfikatora i powiązać z nim płatność |
24 | ordercode1c | integer | code1c zamówienie, do którego należy dołączyć płatność | Pole nie wymagane. | Jeśli określisz, system spróbuje znaleźć zamówienie za pomocą code1c i powiązać z nim płatność |
25 | linkkey | string | Unikalny klucz płatności | Pole nie wymagane. | |
26 | comment | string | Komentarz dotyczący płatności | Pole nie wymagane. | |
27 | invoiceid | integer | ID cpara płatnicza | Pole nie wymagane. | |
28 | nobalance | 1 / 0 | Czy tę wpłatę należy uwzględnić w bilansie ogólnym? | Pole nie wymagane. | |
29 | code1c | string | Code1c płatność (identyfikator płatności z Twojego systemu) | Pole nie wymagane. | |
30 | direction | enum('fromclient','toclient') | Kierunek płatności (domyślnie określony na podstawie kwoty płatności) | Pole nie wymagane. |
Dodanie oczekiwanej płatności, metoda: /api/payment/probation/add/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | pdate | date | Data oczekiwanego otrzymania płatności | Pole obowiązkowe. | |
4 | sum | float | Kwota płatności | Pole obowiązkowe. | Nie może być równe 0 |
5 | currencyid | integer | ID waluta płatności | Pole nie wymagane. | |
6 | currencyname | string | Nazwa waluty płatności | Pole nie wymagane. | |
7 | accountid | integer | ID Konta, na które należy dokonywać płatności w systemie | Pole nie wymagane. | |
8 | accountname | string | Nazwa rachunku, na który należy dokonać płatności w systemie | Pole nie wymagane. | |
9 | managerid | integer | id użytkownika, który dokona płatności | Pole nie wymagane. | Jeśli nie określisz, zostanie pobrany użytkownik, od którego zostanie utworzona płatność |
10 | categoryid | interger | Id kategorie płatności | Pole nie wymagane. | |
11 | categoryname | string | Nazwa kategorii płatności | Pole nie wymagane. | |
12 | orderid | integer | Id zamówienie, do którego należy dołączyć płatność | Pole nie wymagane. | Lub do utworzenia oczekiwanej płatności potrzebny jest identyfikator zamówienia lub kod 1c |
13 | ordercode1c | string | code1c zamówienie, do którego należy dołączyć płatność | Pole nie wymagane. | Lub do utworzenia oczekiwanej płatności potrzebny jest identyfikator zamówienia lub kod 1c |
14 | comment | string | Komentarz dotyczący płatności | Pole nie wymagane. | |
15 | received | 1 / 0 | Czy otrzymano płatność? | Pole nie wymagane. |
Usunięcie płatności metoda: /api/payment/delete/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | paymentid | string | Id Zapłata | Pole obowiązkowe. | Do usunięcia wymagany jest identyfikator lub kod 1c płatności |
4 | paymentcode1c | string | Code1c Zapłata | Pole obowiązkowe. | Do usunięcia wymagany jest identyfikator lub kod 1c płatności |
Usunięcie oczekującej płatności, metoda: /api/payment/probation/delete/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | paymentid | integer | Id Zapłata | Pole obowiązkowe. | id do usunięcia wymagana jest oczekiwana płatność |
4 | nomessage | 1 / 0 | Не создавать уведомление об удалении | Pole nie wymagane. |
Edycja płatności, metoda: /api/payment/update/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
---|---|---|---|---|---|
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | paymentid | string | Id Zapłata | Pole obowiązkowe. | Do edycji wymagany jest identyfikator lub kod 1c płatności |
4 | paymentcode1c | string | Code1c Zapłata | Pole obowiązkowe. | Do edycji wymagany jest identyfikator lub kod 1c płatności |
5 | cdate | datetime | Data utworzenia płatności | Pole nie wymagane. | |
6 | pdate | datetime | Data płatności | Pole nie wymagane. | |
7 | rdate | datetime | Data odmowy płatności | Pole nie wymagane. | |
8 | sum | float | Kwota płatności | Pole nie wymagane. | |
9 | sumbase | float | Kwota płatności w walucie bazowej | Pole nie wymagane. | |
10 | currencyid | integer | ID waluta płatności | Pole nie wymagane. | |
11 | currencyname | string | Nazwa waluty płatności | Pole nie wymagane. | |
12 | accountid | integer | ID Konta, na które należy dokonywać płatności w systemie | Pole nie wymagane. | |
13 | accountname | string | Nazwa rachunku, na który należy dokonać płatności w systemie | Pole nie wymagane. | |
14 | clientid | integer | id klient | Pole nie wymagane. | Jeśli to określisz, system spróbuje znaleźć klienta po identyfikatorze i powiązać z nim płatność |
15 | clientcode1c | string | code1c klient | Pole nie wymagane. | Jeśli określisz, system spróbuje znaleźć klienta za pomocą code1c i powiązać z nim płatność |
16 | orderid | integer | Id zamówienie, do którego należy dołączyć płatność | Pole nie wymagane. | |
17 | ordercode1c | string | Code1c zamówienie, do którego należy dołączyć płatność | Pole nie wymagane. | |
18 | comment | string | Komentarz dotyczący płatności | Pole nie wymagane. |
Otrzymanie jednej oczekiwanej płatności i otrzymanie wszystkich oczekiwanych płatności, metoda: /api/payment/probation/get/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | paymentid | integer | id oczekiwana płatność | Pole obowiązkowe. | Jeśli potrzebujesz konkretnej oczekiwanej płatności, to podajesz w to pole identyfikator oczekiwanej płatności, który został Ci zwrócony przez nasze API podczas jej tworzenia. Zwróć wartości pól id - id Zapłata cdate - Data utworzenia, amount - kwota płatności, amountbase - kwotę płatności w walucie bazowej systemu, orderid - id polecenie zapłaty, ordercode1c - kod procesu płatności zewnętrznej, ordername - nazwa procesu płatności, currencyid - id waluta płatności, currencyname - nazwa waluty płatności, accountid - id Konto płatności, accountname - nazwa rachunku płatniczego, categoryid - id kategorie płatności, categoryname - nazwa kategorii płatności, direction - kierunek płatności, received - czy płatność została otrzymana, managerid - id pracownik, który utworzył płatność, managerName - imię i nazwisko osoby, która utworzyła płatność, |
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | cdatefrom | date | Data utworzenia płatności od | Pole nie wymagane. | |
4 | cdateto | date | Data utworzenia płatności wcześniejsza | Pole nie wymagane. | |
5 | pdatefrom | date | Data otrzymania płatności od | Pole nie wymagane. | |
6 | pdateto | date | Data otrzymania płatności wcześniej | Pole nie wymagane. | |
7 | accountid | integer | id oczekiwany rachunek płatniczy | Pole nie wymagane. | |
8 | accountname | string | Nazwa konta oczekiwanej płatności | Pole nie wymagane. | |
9 | categoryid | integer | id kategorie płatności | Pole nie wymagane. | |
10 | categoryname | string | Nazwa kategorii płatności | Pole nie wymagane. | |
11 | orderid | integer | id proces płatności | Pole nie wymagane. | |
12 | ordercode1c | string | Kod procesu płatności zewnętrznej | Pole nie wymagane. | |
13 | received | 1 / 0 | Czy otrzymano płatność? | Pole nie wymagane. | 1 - tylko otrzymał płatności 0 - tylko nieotrzymane płatności |
10 | part | integer | Niektóre zamówienia | Pole obowiązkowe. | API wydaje w pierwszej części do 1000 oczekiwanych wpłat, aby otrzymać kolejne 1000 zamówień, przelej tam 2 (otrzymujesz część 2) i tak dalej. Zwróć wartości pól id - id Zapłata cdate - Data utworzenia, amount - kwota płatności, amountbase - kwotę płatności w walucie bazowej systemu, orderid - id polecenie zapłaty, ordercode1c - kod procesu płatności zewnętrznej, ordername - nazwa procesu płatności, currencyid - id waluta płatności, currencyname - nazwa waluty płatności, accountid - id Konto płatności, accountname - nazwa rachunku płatniczego, categoryid - id kategorie płatności, categoryname - nazwa kategorii płatności, direction - kierunek płatności, received - czy płatność została otrzymana, managerid - id pracownik, który utworzył płatność, managerName - imię i nazwisko osoby, która utworzyła płatność, |
Otrzymanie jednej płatności rzeczywistej i otrzymanie wszystkich płatności rzeczywistych, metoda: /api/payment/get/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | paymentid | integer | id Zapłata | Pole obowiązkowe. | Jeśli potrzebujesz konkretnej płatności, to w tym polu podajesz identyfikator płatności, który został zwrócony przez nasze API podczas jego tworzenia.. Zwróć wartości pól id - id Zapłata code1c - code1c Zapłata cdate - Data utworzenia amount- Suma currencyid - waluta płatności currencyname - nazwa waluty płatności currencyrate - Dobrze amountbase - płatność w walucie bazowej accountid - id Konto płatności accountname - Nazwa konta categoryid - id kategorie płatności categoryname - nazwa kategorii virtual - Czy jest to płatność wirtualna? direction - kierunek płatności clientid - id klient clientName - Nazwa klienta clientCode1c - code1c klient userid - id kto dokonał płatności userName - imię i nazwisko dyrygenta userCode1c - code1c dyrygowanie documentid - id dokument dotyczący płatności comment - Komentarz referenscode - Kod referencyjny bankdetail - dane bankowe customfields - dodatkowe pola produktowe zamówienia, na które składają się:
|
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | cdatefrom | date | Data utworzenia płatności od | Pole nie wymagane. | |
4 | cdateto | date | Data utworzenia płatności wcześniejsza | Pole nie wymagane. | |
5 | pdatefrom | date | Data otrzymania płatności od | Pole nie wymagane. | |
6 | pdateto | date | Data otrzymania płatności wcześniej | Pole nie wymagane. | |
7 | accountid | integer | id Konto płatności | Pole nie wymagane. | |
8 | accountname | string | Nazwa rachunku płatniczego | Pole nie wymagane. | |
9 | categoryid | integer | id kategorie płatności | Pole nie wymagane. | |
10 | categoryname | string | Nazwa kategorii płatności | Pole nie wymagane. | |
11 | orderid | integer | id proces płatności | Pole nie wymagane. | |
12 | ordercode1c | string | Kod procesu płatności zewnętrznej | Pole nie wymagane. | |
13 | part | integer | Część płatności | Pole obowiązkowe. | API wystawia do 1000 płatności w pierwszej części, aby otrzymać kolejne 1000 zamówień, przelej tam 2 (otrzymujesz część 2) i tak dalej. Zwróć wartości pól id - id Zapłata code1c - code1c Zapłata cdate - Data utworzenia amount- Suma currencyid - waluta płatności currencyname - nazwa waluty płatności currencyrate - Dobrze amountbase - płatność w walucie bazowej accountid - id Konto płatności accountname - Nazwa konta categoryid - id kategorie płatności categoryname - nazwa kategorii virtual - Czy jest to płatność wirtualna? direction - kierunek płatności clientid - id klient clientName - Nazwa klienta clientCode1c - code1c klient userid - id kto dokonał płatności userName - imię i nazwisko dyrygenta userCode1c - code1c dyrygowanie documentid - id dokument dotyczący płatności comment - Komentarz referenscode - Kod referencyjny bankdetail - dane bankowe customfields - dodatkowe pola produktowe zamówienia, na które składają się:
|
Uzyskanie sald wszystkich rachunków finansowych, metoda: /api/payment/balance/get/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
3 | contractortype | string | Тип юридического лица | Не обязательное поле. |
Допустимые значения:
|
4 | accountid | integer | id счета | Не обязательное поле. | Если нужно получить баланс только по 1 счету, необходимо указать этот параметр |
Zwróć wartości pól |
Uzyskanie sald wszystkich budżetów, metoda: /api/budget/balance/get/
Przykład:
№ | Pole | Typ | Opis | Obowiązkowe lub nie | Komentarz |
1 | login | string | Zaloguj się w systemie BOX | Pole obowiązkowe. | |
2 | password | string | Hasło w formacie md5 | Pole obowiązkowe. | Napisz do pomocy technicznej, a my przekażemy Ci hash dla API |
Zwróć wartości pól |
Możliwe odpowiedzi na zapytanie
№ | Status | Wiadomość | Opis wiadomości |
1 | ok | paymentid | id dodana/edytowana płatność |
2 | fail | login_empty | Brak logowania |
3 | fail | password_empty | Brak hasła |
4 | fail | Login or password not correct! | Nieprawidłowy login lub hasło |
5 | fail | Bad user level! | Niski poziom użytkownika, aby wykonać tę akcję (wymagany poziom 2 lub wyższy) |
6 | fail | PaymentCode1c exists | Płatność z tym kodem już istnieje |
7 | fail | FinanceAccount not found | Nie znaleziono konta finansowego |
8 | fail | Payment by id or code1c not found | Płatność o tym samym identyfikatorze lub kodzie już istnieje |
9 | fail | Payment accounts not found | Nie znaleziono kont finansowych |