Przejdź do głównej treści

Utwórz nowy dokument

Ready_™ Developer TeamMniej niż 1 minuta

Utwórz nowy dokument

Definicja Funkcji

int createDocument(array $data)

Definicja parametrów

Metoda przyjmuje jeden parametr jako tablicę lub string JSON. Dostępne klucze:

Parametry do zmiennej $data.

Nazwa parametruTyp parametruOpis
dscrptstring (Wymagany)Opis dokumentu
dctpidint (Wymagany)Typ dokumentu, identyfikator z (Panel Sterowania -> Definicje dokumentów) (types_of_documents.dctpid)
dctptpstring (Zamienny z 'dctpid')Typ dokumentu (types_of_documents.dctptp) Przykład VatNoe, Paper
targetintIndetyfikator stanowiska na który dokument zostanie przekazany. (organization_units.orunid), jeżeli parametr nie zostanie podany to system użyje id stanowiska aktualnie zalogowanego użytkownika
target_searchstringFraza, która zostanie użyta do odszukania stanowiska na które dokument ma być przekazany
prc_idintIndetyfikator sprawy (processes.prc_id)
state_intRodzaj dokumentu
  1.  wychodzący
  2. przychodzący
  3. wewnętrzny
adduidintOsoba dodająca dokument (users.usr_id), jeżeli parametr nie zostanie podany to system użyje id aktualnie zalogowanego użytkownika
from_contact_symbolstringSymbol nadawcy (contacts.symbol)
to_contacts_symbolstringSymbol odbiorcy (contacts.symbol)
from_contidintId nadawcy (contacts.contid)
to_contidintId odbiorcy (contacts.contid)
numberstringNumer dokumentu
symgenboolFlaga czy ma być generowany numer dokumentu. Dotyczy tylko tych dokumentów, które na formatce mają pole zaznaczenia "Generuj symbol" np. Zapotrzebowanie
tpstidintIdentyfikator statusu dokumentu (types_of_processes_states.tpstid)
prtpidintIndetyfikator procedury (procedures_def.prtpid)

Przykład użycia

require_once('./classes/eDokumentyApi/EDokApi.inc');
 $api = new \EDokApi();
        
 try {
    $data = [
        'dscrpt' => 'Testowy dokument'.date('d H:m:s'),
        'dctpid' => 4
    ];
    $doc_id = $api->createDocument($data);
 } catch(Exception $e) {
    throw new \Exception($e->getMessage());
 }           

Zwracane dane lub wyjątki

Metoda zwraca ID dokumentu (documents.doc_id) w przypadku sukcesu. Jeśli wystąpi błąd wtedy, zostanie zwrócony wyjątek.

Zwracane wyjątki w zależności od wywołania

  • SOAP - SoapFault
  • Lokalnie - Exception