Dokumentacja wfirma.pl

API2

Autoryzacja

Zalecaną metodą autoryzacji jest OAuth, jednak w najprostszej wersji autoryzacja odbywa się poprzez przekazanie loginu i hasła podczas każdego zapytania poprzez mechanizm HTTP Basic Auth. Metoda nie jest dostępna w przypadku gdy włączone jest dwuetapowe logowanie.

W przypadku korzystania z Basic Auth stosowany jest limit 5 nieudanych prób logowania, po których dostęp jest blokowany na 5 minut.

Basic Auth

Przykład pobrania listy faktur

Przykład pobrania faktury w PDF z linii poleceń

OAuth

OAuth jest otwartym standardem autoryzacyjnym umożliwiającym wykonanie autoryzacji po stronie wfirma.pl. Użytkownik logujący się do wfirma.pl uwierzytelnia aplikację do konkretnych modułów. Więcej o OAuth na wikipedia.org oraz oauth.net.

W wfirma.pl możliwa jest autoryzacja po OAuth w wersji 1.0a. Serwis akceptuje jedynie zapytania, które nie są szyfrowane na poziomie protokołu OAuth (signature method = plaintext), więc komunikacja powinna odbywać się przez SSL z użyciem protokołu HTTPS. Zapytania requestToken i accessToken powinny być wykonane metodą GET.

Zapytania URL nie różnią się w żaden sposób od zapytań realizowanych przy autoryzacji przez mechanizm HTTP Basic Auth. Jedyne zmiany wynikają z dodatkowych nagłówków, koniecznych przy OAuth oraz komunikacji przez HTTPS, zamiast HTTP.

Niezbędne informacje

  • consumer_key, consumer_secret - dostarczane przez wfirma.pl indywidualnie dla każdej aplikacji
  • server_uri - https://api2.wfirma.pl
  • signature_method - PLAINTEXT
  • request_token_uri - https://wfirma.pl/oauth/requestToken
  • authorize_uri - https://wfirma.pl/oauth/authorize
  • access_token_uri - https://wfirma.pl/oauth/accessToken

Uzyskiwanie consumer_key oraz consumer_secret

W celu uzyskania consumer_key oraz consumer_secret (varchar(32)) konieczne jest wysłanie wiadomości na adres e-mail pomoc@wfirma.pl. W wiadomości proszę zawrzeć informacje:

  • nazwa producenta
  • numer telefonu producenta
  • adres e-mail producenta
  • adres www producenta
  • nazwa aplikacji
  • krótki opis aplikacji

Uprawnienia aplikacji

Platforma API została podzielona na zakresy (scopes). Możliwe jest uzyskanie dostępu do jednego lub więcej zakresów jednocześnie. Każdy moduł API dzieli się na dwa zakresy: do odczytu i do zapisu. Zakresy określane są w następujący sposób: <nazwa_modułu>-<read|write>, np. invoices-read lub invoices-write. Zakres do odczytu najczęściej określa dostęp do metod find/get, natomiast zakres do zapisu add/edit/delete.

W przypadku próby zapytania do zakresu, do którego nie ma się dostępu zwracany jest komunikat błędu DENIED_SCOPE_REQUESTED. Taka sytuacja powinna być obsłużona po stronie aplikacji.

Uzyskanie autoryzacji użytkownika

Uzyskanie autoryzacji aplikacji przez użytkownika skutkuje przydzieleniem access_token oraz access_token_secret (varchar(32)), które powinny być zapamiętane po stronie aplikacji, ponieważ konieczne jest ich wykorzystanie przy każdym zapytaniu do API.

Uzyskiwanie tych danych odbywa się zgodnie z dokumentacją OAuth. Przykładową implementację można znaleźć poniżej.

Implementacja podstawowych funkcji przy korzystaniu z biblioteki OAuth w PHP.

Zgoda użytkownika na dostęp do danych

Uzyskanie access_token oraz access_token_secret

Pobieranie danych z API

Historia zmian API2

2015-11-01

  • Możliwość wyszukiwania i sortowania po polach powiązanych modułów (tych które są w relacji 1-1)
  • Dodanie nowego parametru fields, ograniczającego zbiór wynikowy.

2015-02-28

  • Zmiana struktury faktury - dostosowanie do zagranicznych stawek VAT (MOSS)
  • Dodanie nowych modułów vat_moss_details, vat_contents i vat_codes związanych z obsługą nowych stawek VAT
  • Webhooks

2014-10-12

  • Dodany moduł documents z akcjami add, delete, find, get, download

2014-02-10

  • Dodanie limitu 5 nieudanych prób logowania w przypadku prostej autoryzacji

2014-01-01

  • Dodany moduł invoice_deliveries (Rozliczenia dostaw) z akcjami add, delete, find, get
  • Zmiana struktury modułu invoices w tym dostosowanie do zmian księgowych, które wejdą 1 stycznia 2014:
    • Dodanie pola disposaldate_empty - w przypadku wartości 1 możliwość wprowadzanie pustej daty sprzedaży. Dotyczy faktur po 1 stycznia 2014 roku.
    • Zmodyfikowana lista schematów księgowych
    • Zmiana rachunków na faktury (bez VAT) - zmiana tylko w nazwie dokumentu
    • Wprowadzenie nowego typu dokumentu pro forma (bez VAT)
    • Likwidacja nieużywanego pola sellerinfo
    • Dodanie pola automatycznej wysyłki faktur przez Postivo

2012-02-17

  • Dodany moduł expenses (Wydatki) z akcjami find oraz get
  • Dodany moduł payments (Płatności) z akcjami add, edit, delete, find, get
  • Drobne poprawki w odpowiedzi modułu goods
  • Możliwość powiązania FV z fakturą proforma poprzez <invoice><order><id>ID_PROFORMY</id></order></invoice>

2012-10-01

  • Dodany moduł companies
  • Dodany moduł company_accounts
  • Dodany moduł company_packs
  • Dodany moduł declaration_countries
  • Dodany moduł invoice_descriptions
  • Dodany moduł payment_cashboxes
  • Dodany moduł translation_languages
  • Dodany moduł user_companies
  • Dodany moduł users
  • Dodany moduł user_companies

Komunikacja

Konwencja nazw akcji

Nazewnictwo akcji z założenia jest stałe:

  • get
  • find
  • add
  • edit
  • delete

Zdarzają się dodatkowe akcje, które nie zawierają się w powyższej liście, np. /invoices/download.

Szczegółowy opis akcji dostępnych w danym module znajduje się przy dokumentacji konkretnego modułu

Odnośniki URL akcji tworzone są w konwencji: https://api2.wfirma.pl/NAZWA_MODUŁU/NAZWA_AKCJI. Podawanie id do akcji odbywa się w sposób: https://api2.wfirma.pl/NAZWA_MODUŁU/NAZWA_AKCJI/IDENTYFIKATOR, chyba że jest napisane inaczej.

Format wymiany danych

Każdorazowo w każdym zapytaniu lub odpowiedzi mamy do czynienia z maksymalnie dwoma gałęziami najwyższego poziomu. W formacie XML objęte są one gałęzią api. Dwie główne gałęzie to:

  • status - zawiera w sobie gałąź code z ogólnym kodem zapytania.
  • Gałąź o nazwie modułu w formie mnogiej, np. invoices. Gałąź ta zawiera w sobie gałęzie:
    • parameters - parametry zapytania
    • Gałąź o nazwie modułu w formie pojedynczej, np. invoice. Ilość tych gałęzi może być dowolna. Przy formacie JSON takie gałęzie muszą być zawsze numerowane za pomocą klucza (nawet jeśli istnieje tylko jedna taka gałąź). Od tej gałęzi wychodzą kolejne gałęzie, których kolejność nie ma znaczenia i mogą to być:
      • Identyfikujące poszczególne pola, np. id, date. Szczegółowe opisy pól gałęzi można znaleźć na podstronach poszczególnych modułów.
      • Gałęzie identyfikujące powiązane moduły, np: zawartość faktury (invoice_content) wewnątrz rekordu faktury (invoice).
        Szególowe informacje na temat możliwych powiązań modułów można znaleźć przy opisie każdego z modułów
        • Forma skrócona: gałąź zawiera jedynie pole id. O szczegółowe dane należy dopytać się osobnym zapytaniem.
        • Forma pełna: gałąź zawiera wszystkie pola powiązanego modułu. Opisy poszczególnych pól można znaleźć w sekcji nt. modułu powiązanego.
        • Typ pojedynczy - nazwa gałęzi jest w formie pojedynczej: powiązany jest maksymalnie jeden rekord tego modułu (np. company_details).
        • Typ mnogi - nazwa gałęzi jest w formie mnogiej: możliwe powiązanie większej ilości rekordów tego modułu. Każdy z rekordów znajduje się w osobnej gałęzi o nazwie modułu w formie pojedynczej.

Przykładowa odpowiedź

Implementacja

Implementacja po stronie klienta API nie powinna zwracać uwagi na kolejność gałęzi o różnych nazwach.

Jeżeli mamy do czynienia z dwoma gałęziami o tej samej nazwie, to ich kolejność może mieć znaczenie (np. w przypadku akcji /invoices/find segregowanej po dacie wystawienia).

W przyszłości wraz z rozrostem API mogą znaleźć się w odpowiedzi gałęzie, których teraz nie przewidziano. Powinno się wziąć to pod uwagę podczas implementacji klienta API - dodatkowe elementy w odpowiedzi nie powinny mieć znaczenia przy realizacji danej akcji.

Obie poniższe gałęzie są równoważne

Format wejściowy / wyjściowy

Wybór preferowanego formatu przez klienta API odbywa się za pomocą dodatkowych parametrów (inputFormat i outputFormat) przekazanych w URL'u, np: https://api2.wfirma.pl/companies/add?inputFormat=json&outputFormat=xml.

Dozwolone wartości to: xml (domyślny) i json.

Jeśli nie został ustawiony format wyjściowy, to jest on tożsamy z formatem wejściowym.

Serwer API w transparentny sposób konwertuje z/do każdego obsługiwanego formatu.

Poniżej jest przykładowa, standardowa odpowiedź na /users/get/124233, /users/add lub /users/edit/124233
users > user to jest nowo dodany / zmodyfikowany / znaleziony rekord
id, login, created, modified są polami rekordu
status > code - ogólny status odpowiedzi

Odpowiedź w XML

Odpowiedź w JSON

Komunikaty błędów

Przerywające komunikaty błędów

  • ACTION NOT FOUND
    Wywoływana akcja nie istnieje. Sprawdź czy w poprawny sposób podałeś odnośnik.
  • NOT FOUND
    Podany obiekt nie istnieje.
  • AUTH
    Wykonanie akcji wymaga podania nazwy użytkownika i hasła. Ten błąd wyświetla się także w przypadku niepoprawnej nazwy użytkownika lub hasła.
  • FATAL
    Wewnętrzny błąd API. Nie powinien nastąpić. Takie zdarzenia będą monitorowane i analizowane indywidualnie.
  • INPUT ERROR
    Podane dane wejściowe są niepoprawne. Np. struktura XML jest nieprawidłowa.
  • ERROR
    Podczas próby dodania lub modyfikacji obiektu wystąpiły błędy walidacji. Szczegółowe informacje na temat błędów walidacji znajdują się niżej.
  • OUT OF SERVICE
    Serwis API tymczasowo wyłączony. Proszę spróbować później. Wyłączenia serwisu można się spodziewać podczas aktualizacji wfirma.pl lub samego API.
  • DENIED SCOPE REQUESTED
    Próba wywołania zakresu do którego nie ma się dostępu (tylko przy autoryzacji przez OAuth).
Przykład

Walidacyjne komunikaty błędów

Walidacyjne komunikaty błędów doklejają do wysłanych wejściowych błędy i wysyłają je jako dane wyjściowe. Błędy są doklejane w gałęzi pojedynczego rekordu (np. api > invoices > invoice).

Cechy błędów walidacji:

  • Może istnieć wiele gałęzi errors > error.
  • Gałąź errors > error > method > parameters zostaje pusta, jeśli parametry nie istnieją.
  • W przypadku wystąpienia błędu walidacji ogólny status (api > status > code) przyjmuje wartość ERROR.
Struktura błędu walidacji
Przykładowy rekord z błędami walidacji

Konstruowanie zapytań find

Metoda find w każdym dostępnym module API umożliwia przekazywanie dodatkowych warunków do zapytania, możliwe jest przekazanie:

  • ilości wyników na stronę
  • nr strony z wynikami (page: liczone od 1)

    Zapytanie o 2 stronę wyników z limitem 10 na stronę

  • Ograniczenie zbioru wyników wyszukiwania do określonych pól. Parametr może w znanczym stopniu poprawić wydajność zapytań.

  • Warunki zapytania (conditions, odpowiednik WHERE w SQL). Można w nich wykorzystywać pola powiązanych modułów, które są w relacji 1-1.
    • sekcja conditions może zawierać jedną lub więcej sekcji condition
    • domyślnym spójnikiem jest AND
    • warunki można łączyć
    • pole operator może przyjmować następujące wartości:
      • eq - równa się
      • ne - nie równa się
      • gt - większe niż
      • lt - mniejsze niż
      • ge - większe lub równe
      • le - mniejsze lub równe
      • like - odpowiednik MySQL'owego LIKE
      • not like - odpowiednik MySQL'owego NOT LIKE
      • in - odpowiednik MySQL'owego IN

  • Wyniki można sortować po polach modułu głównego oraz powiązanych modułach, które są w relacji 1-1.

Moduły

contractors

Moduł odpowiedzialny za zarządzanie danymi kontrahentów.

Akcje

  • add - dodawanie kontrahenta
  • edit - modyfikacja kontrahenta o podanym id
  • get - pobranie szczegółów kontrahenta o podanym id
  • find - pobranie listy kontrahentów
  • delete - usunięcie kontrahenta o podanym id

Powiązane moduły

  • translation_languages (skrócony, pojedynczy)
  • company_accounts (skrócony, pojedynczy)
  • invoice_descriptions (skrócony, pojedynczy)

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameOdczyt i zapisNazwa pełna
altnameOdczyt i zapisNazwa skrócona
tax_id_typeOdczyt i zapisRodzaj identyfikatora podatkowego. Dopuszczalne wartości nip, vat, pesel, regon, custom, none.
nipOdczyt i zapisIdentyfikator podatkowy
regonOdczyt i zapisIdentyfikator REGON. Pole nie jest używane w systemie.
Adres główny kontrahenta
streetOdczyt i zapisUlica
zipOdczyt i zapisKod pocztowy
cityOdczyt i zapisMiasto
countryOdczyt i zapisDwuliterowy kod kraju według listy z modułu declaration_countries.
Adres kontaktowy kontrahenta
different_contact_addressOdczyt i zapisCzy adres kontaktowy różni się od adresu głównego. 1 - TAK, 0 - NIE
contact_nameOdczyt i zapisNazwa
contact_streetOdczyt i zapisUlica
contact_zipOdczyt i zapisKod pocztowy
contact_cityOdczyt i zapisMiasto
contact_countryOdczyt i zapisDwuliterowy kod kraju według listy z modułu declaration_countries.
contact_personOdczyt i zapisOsoba kontaktowa
phoneOdczyt i zapisTelefon
skypeOdczyt i zapis
faxOdczyt i zapis
emailOdczyt i zapis
urlOdczyt i zapisAdres strony kontrahenta
descriptionOdczyt i zapisOpis kontrahenta
buyerOdczyt i zapisWartość 1 dla oznaczenia, że kontrahent jest nabywcą
sellerOdczyt i zapisWartość 1 dla oznaczenia, że kontrahent jest dostawcą
account_numberOdczyt i zapisNumer rachunku bankowego kontrahenta
discount_percentOdczyt i zapisDomyślna wartość rabatu w procentach, która będzie stosowana dla kontrahenta. Dla rabatu 50% należy wprowadzić wartość 50.
payment_daysOdczyt i zapisDomyślny termin płatności
payment_methodOdczyt i zapisDomyślna metoda płatności
remindOdczyt i zapisW przypadku wartości 1 i włączonych automatycznych powiadomieniach o niezapłaconych fakturach, kontrahent otrzyma monit w przypadku braku zapłaty za fakturę.
hashOdczyt i zapisWartość hasha zabezpieczającego panel klienta (dostępnego przez odsyłacz http://wfirma.pl/invoice_externals/find/HASH).
notesTylko do odczytuLiczba notatek powiązanych z kontrahentem
documentsTylko do odczytuLiczba dokumentów powiązanych z kontrahentem
tagsOdczyt i zapisZnaczniki powiązane z kontrahentem w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

Zapytanie do akcji /contractors/add

Odpowiedź

companies

Akcje

  • get - pobranie informacji o firmie dla której wykonywane jest ninejsze zapytanie

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameTylko do odczytuNazwa pełna
altnameTylko do odczytuNazwa skrócona
nipTylko do odczytu
vat_payerTylko do odczytu1 - firma jest płatnikiem VAT, 0 - firma jest nievatowcem
taxTylko do odczytutaxregister - firma prowadzi KPiR, lumpregister firma prowadzi Ewidencję Przychodów (ryczałt)
is_registeredTylko do odczytu1 w przypadku dokończenia rejestracji firmy w systemie
is_authorizedTylko do odczytu1 w przypadku, gdy firma jest autoryzowana w systemie
edeclarations_verifiedTylko do odczytu1 w przypadku, gdy firma została zweryfikowana dla potrzeb wysyłki edeklaracji przy użyciu podpisu pracowników wfirma.pl

company_accounts

Akcje

  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameOdczyt i zapisNazwa rachunku widoczna w panelu wfirmy
bank_nameOdczyt i zapisNazwa banku
numberOdczyt i zapisNumer rachunku bankowego
swiftOdczyt i zapisKod SWIFT
addressOdczyt i zapisAdres banku
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

company_packs

Nie można zapewnić kompatybilności wstecznej tego modułu API. Możliwa jest zmiana struktury odpowiedzi w przyszłości.

Akcje

  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
packTylko do odczytupack_trade - pakiet Fakturowanie
pack_tradew - pakiet Fakturowanie i Magazyn
pack_book - pakiet Fakturowanie i Księgowość
pack_bookw - pakiet Fakturowanie, Księgowość i Magazyn
monthsTylko do odczytuNa jaki okres przedłużany jest pakiet
expiration_dateTylko do odczytuData ważności pakietu
statusTylko do odczytuStatus aktywności pakietu, pole aktulizowane przy logowaniu do systemu.
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

declaration_countries

Akcje

  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameTylko do odczytuNazwa kraju
codeTylko do odczytuDwuliterowy kod kraju według klasyfikacji określonej w systemie e-deklaracje.
priorityTylko do odczytuCzęściej stosowane kraje mają ustawiony wyższy priorytet, przez co są wymienione wyżej na liście krajów do wyboru w systemie
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

documents

Akcje

  • add
  • delete
  • find
  • get
  • download

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
object_nameOdczyt i zapisNazwa powiązanego obiektu
object_idOdczyt i zapisId powiązanego obiektu
nameOdczyt i zapisNazwa dokumentu
textOdczyt i zapisTreść - dotyczy dokumentu typu document_template
urlOdczyt i zapisOdsyłacz - dotyczy dokument typu url
filenameOdczyt i zapisNazwa pliku
mimeOdczyt i zapis
sizeTylko do odczytuRozmiar w bajtach
iconTylko do odczytuIkona widoczna na liście
typeOdczyt i zapisTyp dokumentu
file - zwykły plik,
document_template - wydruk wygenerowany z szablonu dokumentu
url - odsyłacz
notesTylko do odczytuLiczba notatek powiązanych z dokumentem
tagsOdczyt i zapisZnaczniki powiązane z dokumentem w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

expenses

Akcje

  • find
  • get

goods

Zarządzanie katalogiem produktów.

Akcje

  • edit - modyfikacja produktu o podanym id
  • get - pobranie szczegółów produktu o podanym id
  • delete - usunięcie produktu o podanym id
  • add - dodawanie produktu
  • find - pobranie listy produktów

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameOdczyt i zapisNazwa produktu
codeOdczyt i zapisKod produktu
unitOdczyt i zapisJednostka
nettoOdczyt i zapisCena netto
bruttoOdczyt i zapisCena brutto
lumpcodeOdczyt i zapisStawka zryczałtowanego podatku od przychodu. Pole powinno być ustawione tylko w przypadku prowadzenia Ewidencji Przychodów (ryczałt).
typeOdczyt i zapisgood - oznacza, że produkt jest towarem, service oznacza, że produkt jest usługą
classificationOdczyt i zapisKod w klasyfikacji PKWiU
discountOdczyt i zapis1 - oznacza, że cena produktu będzie pomniejszona o rabat dla kontrahenta, 0 w przeciwnym przypadku
descriptionOdczyt i zapisOpis produktu
notesTylko do odczytuLiczba notatek powiązanych z produktem
documentsTylko do odczytuLiczba dokumentów powiązanych z produktem
tagsOdczyt i zapisZnaczniki powiązane z produktem w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
countOdczyt i zapisIlość produktu. W przypadku włączonego magazynu pole jest tylko do odczytu.
Pola używane przy włączonym magazynie, dotyczą aktywnego magazynu
lub wybranego za pomocą parametru GET warehouse_id=[id]
reservedTylko do odczytuIlość zarezerwowanego produktu
minOdczyt i zapisGranica stanu minimalnego produktu
maxOdczyt i zapisGranica stanu maksymalnego produktu
secureOdczyt i zapisGranica stanu bezpiecznego produktu
visibilityOdczyt i zapisWidoczność produktu w magazynie/katalogu produktów
warehouse_typeTylko do odczytusimple - informacje o ilości w prostym katalogu produktów,
extended - informacje o ilości przy włączonym module magazynowym
price_typeOdczyt i zapisPole decyduje o tym czy podatek jest liczony od ceny netto czy brutto
vatOdczyt i zapisStawka podatku VAT

Zapytanie do akcji /goods/add

Odpowiedź

invoices

Akcje

  • find - pobranie listy faktur
  • get - pobranie szczegółów faktury o podanym id
  • download - pobranie wydruku faktury w PDF
    akcja przyjmuje 4 parametry (przykład zapytania znajduje się w dolnej części sekcji):
    • page
      Dozwolone wartości:
      • all - wydruk oryginału i kopii
      • invoice - wydruk oryginału
      • invoicecopy - wydruk kopii
    • address - adres korespondencyjny nabywcy na odwrocie oryginału faktury, umieszczony w takim miejscu, by po złożeniu faktury do rozmiaru DL w Z, adres był na wysokości okienka w kopercie (dozwolone wartości: 0 lub 1)
    • leaflet - druczek przelewu jest generowany tylko dla faktur z metodą płatności "przelew" w walucie PLN. (dozwolone wartości: 0 lub 1)
    • duplicate - w przypadku gdy nasz kontrahent zgubi od nas fakturę, należy przekazać mu duplikat (dozwolone wartości 0 lub 1)
  • add - dodawanie faktury
  • edit - edycja faktury o podanym id
  • delete - usunięcie faktury o podanym id

Powiązane moduły

  • contractor_details (pełny, pojedynczy)
  • company_details (pełny, pojedynczy)
  • vat_moss_details (pełny, pojedynczy)
  • invoicecontents (pełny, mnogi)
  • vat_contents (pełny, mnogi)
  • series (skrócony, pojedynczy)
  • companies (skrócony, pojedynczy)
  • contractors (skrócony, pojedynczy)
  • invoices (skrócony, pojedynczy) - pod gałęzią parent
  • invoices (skrócony, pojedynczy) - pod gałęzią order
  • cronemails (skrócony, pojedynczy) - pod gałęzią cronemail
  • cronemails (skrócony, pojedynczy) - pod gałęzią cronemail2
  • expenses (skrócony, pojedynczy)
  • company_accounts (skrócony, pojedynczy)
  • payment_cashboxes (skrócony, pojedynczy)
  • translation_languages (skrócony, pojedynczy)
  • postivo_shipments (skrócony, pojedynczy)
  • postivo_shipment_contents (skrócony, pojedynczy)

Pola

Faktura VAT
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku faktury:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia faktury
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem faktury bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem faktury z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu faktury. Kwota jest widoczna na wydruku faktury.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - normal
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy faktury
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku faktury
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku faktury. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce faktury. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia faktury. Wartość określana automatycznie na podstawie ustawień.
schemaOdczyt i zapisSchemat księgowy. W przypadku faktur dotyczących sprzedaży po 1 stycznia 2014 należy stosować schematy:
normal - faktura księgowana do rejestru VAT w dacie sprzedaży,
vat_invoice_date - faktura księgowana do rejestru VAT dacie wystawienia
assessor - faktura za opinię biegłego (tylko do rejestru VAT metodą kasową)
schema_billOdczyt i zapisOpcja faktura do paragonu
schema_canceledOdczyt i zapisOpcja faktura anulowana
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
nettoTylko do odczytuWartość netto ogółem
taxTylko do odczytuWartość podatku ogółem
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
hashTylko do odczytuHash zabezpieczający odsyłacz do faktury w panelu klienta
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania faktury był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z fakturą
documentsTylko do odczytuLiczba dokumentów powiązanych z fakturą
tagsOdczyt i zapisZnaczniki powiązane z fakturą w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
price_typeOdczyt i zapisRodzaj ceny - netto lub brutto
Pro forma
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku faktury:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia faktury
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem faktury bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem faktury z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu faktury. Kwota jest widoczna na wydruku faktury.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - proforma
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy faktury
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku faktury
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku faktury. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce faktury. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia faktury. Wartość określana automatycznie na podstawie ustawień.
schemaOdczyt i zapisSchemat księgowy. W przypadku faktur dotyczących sprzedaży po 1 stycznia 2014 należy stosować schematy:
normal - faktura księgowana do rejestru VAT w dacie sprzedaży,
vat_invoice_date - faktura księgowana do rejestru VAT dacie wystawienia
assessor - faktura za opinię biegłego (tylko do rejestru VAT metodą kasową)
schema_billOdczyt i zapisOpcja faktura do paragonu
schema_canceledOdczyt i zapisOpcja faktura anulowana
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
nettoTylko do odczytuWartość netto ogółem
taxTylko do odczytuWartość podatku ogółem
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
hashTylko do odczytuHash zabezpieczający odsyłacz do faktury w panelu klienta
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania faktury był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z fakturą
documentsTylko do odczytuLiczba dokumentów powiązanych z fakturą
tagsOdczyt i zapisZnaczniki powiązane z fakturą w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
price_typeOdczyt i zapisRodzaj ceny - netto lub brutto
Paragon niefiskalny
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
schema_receipt_bookOdczyt i zapisCzy paragon ma być księgowany
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku faktury:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia faktury
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem faktury bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem faktury z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu faktury. Kwota jest widoczna na wydruku faktury.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - receipt_normal
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy faktury
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku faktury
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku faktury. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce faktury. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia faktury. Wartość określana automatycznie na podstawie ustawień.
schemaOdczyt i zapisSchemat księgowy. W przypadku faktur dotyczących sprzedaży po 1 stycznia 2014 należy stosować schematy:
normal - faktura księgowana do rejestru VAT w dacie sprzedaży,
vat_invoice_date - faktura księgowana do rejestru VAT dacie wystawienia
assessor - faktura za opinię biegłego (tylko do rejestru VAT metodą kasową)
schema_billOdczyt i zapisOpcja faktura do paragonu
schema_canceledOdczyt i zapisOpcja faktura anulowana
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
nettoTylko do odczytuWartość netto ogółem
taxTylko do odczytuWartość podatku ogółem
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
hashTylko do odczytuHash zabezpieczający odsyłacz do faktury w panelu klienta
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania faktury był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z fakturą
documentsTylko do odczytuLiczba dokumentów powiązanych z fakturą
tagsOdczyt i zapisZnaczniki powiązane z fakturą w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
price_typeOdczyt i zapisRodzaj ceny - netto lub brutto
Paragon fiskalny
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
schema_receipt_bookOdczyt i zapisCzy paragon ma być księgowany
receipt_fiscal_printedTylko do odczytuCzy paragon został wydrukowany
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku faktury:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia faktury
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem faktury bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem faktury z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu faktury. Kwota jest widoczna na wydruku faktury.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - receipt_fiscal_normal
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy faktury
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku faktury
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku faktury. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce faktury. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia faktury. Wartość określana automatycznie na podstawie ustawień.
schemaOdczyt i zapisSchemat księgowy. W przypadku faktur dotyczących sprzedaży po 1 stycznia 2014 należy stosować schematy:
normal - faktura księgowana do rejestru VAT w dacie sprzedaży,
vat_invoice_date - faktura księgowana do rejestru VAT dacie wystawienia
assessor - faktura za opinię biegłego (tylko do rejestru VAT metodą kasową)
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
nettoTylko do odczytuWartość netto ogółem
taxTylko do odczytuWartość podatku ogółem
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania faktury był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z fakturą
documentsTylko do odczytuLiczba dokumentów powiązanych z fakturą
tagsOdczyt i zapisZnaczniki powiązane z fakturą w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
Inny przychód - sprzedaż
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
fullnumberOdczyt i zapisNumer dokumentu
income_lumpcodeOdczyt i zapisStawka ryczałtu w przypadku prowadzenia Ewidencji przychodów
income_correctionOdczyt i zapisOznaczenie, że dany przychód jest przychodem korygującym
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku innego przychodu:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia innego przychodu
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem innego przychodu bez uwzględnienia ewentualnych korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu innego przychodu. Kwota jest widoczna na wydruku innego przychodu.
remainingTylko do odczytuKwota pozostało do zapłaty
typeOdczyt i zapisTyp dokumentu - income_normal
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy innego przychodu
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku innego przychodu
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku innego przychodu. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce innego przychodu. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia innego przychodu. Wartość określana automatycznie na podstawie ustawień.
schemaOdczyt i zapisSchemat księgowy. W przypadku faktur dotyczących sprzedaży po 1 stycznia 2014 należy stosować schematy:
normal - faktura księgowana do rejestru VAT w dacie sprzedaży,
vat_invoice_date - faktura księgowana do rejestru VAT dacie wystawienia
assessor - faktura za opinię biegłego (tylko do rejestru VAT metodą kasową)
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
nettoTylko do odczytuWartość netto ogółem
taxTylko do odczytuWartość podatku ogółem
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
id_externalOdczyt i zapisPole do zapisywania własnych wartości
notesTylko do odczytuLiczba notatek powiązanych z innym przychodem
documentsTylko do odczytuLiczba dokumentów powiązanych z innym przychodem
tagsOdczyt i zapisZnaczniki powiązane z innym przychodem w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
price_typeOdczyt i zapisRodzaj ceny - netto lub brutto
Faktura (bez VAT)
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
bill_legal_descriptionTylko do odczytuOpis z informacją o podstawie prawnej zwolnienia z VAT. Wartość określona na podstawie ustawień firmy.
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku faktury:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia faktury
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem faktury bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem faktury z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu faktury. Kwota jest widoczna na wydruku faktury.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - bill
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy faktury
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku faktury
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku faktury. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce faktury. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia faktury. Wartość określana automatycznie na podstawie ustawień.
schema_billOdczyt i zapisOpcja faktura do paragonu
schema_canceledOdczyt i zapisOpcja faktura anulowana
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
hashTylko do odczytuHash zabezpieczający odsyłacz do faktury w panelu klienta
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania faktury był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z fakturą
documentsTylko do odczytuLiczba dokumentów powiązanych z fakturą
tagsOdczyt i zapisZnaczniki powiązane z fakturą w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
Pro forma (bez VAT)
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku faktury:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia faktury
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem faktury bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem faktury z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu faktury. Kwota jest widoczna na wydruku faktury.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - proforma_bill
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy faktury
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku faktury
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku faktury. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce faktury. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia faktury. Wartość określana automatycznie na podstawie ustawień.
schema_billOdczyt i zapisOpcja faktura do paragonu
schema_canceledOdczyt i zapisOpcja faktura anulowana
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
hashTylko do odczytuHash zabezpieczający odsyłacz do faktury w panelu klienta
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania faktury był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z fakturą
documentsTylko do odczytuLiczba dokumentów powiązanych z fakturą
tagsOdczyt i zapisZnaczniki powiązane z fakturą w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
Paragon niefiskalny (bez VAT)
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
schema_receipt_bookOdczyt i zapisCzy paragon ma być księgowany
bill_legal_descriptionTylko do odczytuOpis z informacją o podstawie prawnej zwolnienia z VAT. Wartość określona na podstawie ustawień firmy.
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku paragonu:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia paragonu
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem paragonu bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem paragonu z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu paragonu. Kwota jest widoczna na wydruku paragonu.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru paragonu. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru paragonu. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru paragonu. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru paragonu. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - receipt_bill
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy paragonu
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku paragonu
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku paragonu. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce paragonu. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia paragonu. Wartość określana automatycznie na podstawie ustawień.
schema_billOdczyt i zapisOpcja paragon do paragonu
schema_canceledOdczyt i zapisOpcja paragon anulowana
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
hashTylko do odczytuHash zabezpieczający odsyłacz do paragonu w panelu klienta
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania paragonu był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z paragonem
documentsTylko do odczytuLiczba dokumentów powiązanych z paragonem
tagsOdczyt i zapisZnaczniki powiązane z paragonem w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
Paragon fiskalny (bez VAT)
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
schema_receipt_bookOdczyt i zapisCzy paragon ma być księgowany
receipt_fiscal_printedTylko do odczytuCzy paragon został wydrukowany
bill_legal_descriptionTylko do odczytuOpis z informacją o podstawie prawnej zwolnienia z VAT. Wartość określona na podstawie ustawień firmy.
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku faktury:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia faktury
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
totalTylko do odczytuKwota razem faktury bez uwzględnienia ewentualnych korekt
total_composedTylko do odczytuKwota razem faktury z uwzględnieniem korekt
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu faktury. Kwota jest widoczna na wydruku faktury.
remainingTylko do odczytuKwota pozostało do zapłaty
Numeracja faktury
numberOdczyt i zapisNumer wstawiany w miejsce znacznika [numer] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
dayOdczyt i zapisDzień wstawiany w miejsce znacznika [dzień] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
monthOdczyt i zapisMiesiąc wstawiany w miejsce znacznika [miesiąc] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
yearOdczyt i zapisRok wstawiany w miejsce znacznika [rok] we wzorcu serii numeracji przy tworzeniu numeru faktury. Pole możliwe do edycji przy wyłączonej kontroli numeracji w zakładce Ustawienia / serie numeracji.
fullnumberTylko do odczytuNumer wygenerowany na podstawie wzorca serii numeracji oraz daty wystawienia lub pól określony powyżej.
semitemplatenumberTylko do odczytuCzęściowo wygenerowany numer. Pole wykorzystywane wewnętrznie do wygenerowania wartości [number] na podstawie wcześniejszych dokumentów z danej serii numeracji.
typeOdczyt i zapisTyp dokumentu - receipt_fiscal_bill
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy faktury
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku faktury
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku faktury. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce faktury. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia faktury. Wartość określana automatycznie na podstawie ustawień.
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
id_externalOdczyt i zapisPole do zapisywania własnych wartości
warehouse_typeTylko do odczytuPole określa czy w trakcie wystawiania faktury był włączony moduł magazynowy (extended) czy katalog produktów (simple)
notesTylko do odczytuLiczba notatek powiązanych z fakturą
documentsTylko do odczytuLiczba dokumentów powiązanych z fakturą
tagsOdczyt i zapisZnaczniki powiązane z fakturą w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu
Inny przychód - sprzedaż (bez VAT)
Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
fullnumberOdczyt i zapisNumer dokumentu
totalOdczyt i zapisKwota razem
income_lumpcodeOdczyt i zapisStawka ryczałtu w przypadku prowadzenia Ewidencji przychodów
income_correctionOdczyt i zapisOznaczenie, że dany przychód jest przychodem korygującym
bill_legal_descriptionTylko do odczytuOpis z informacją o podstawie prawnej zwolnienia z VAT. Wartość określona na podstawie ustawień firmy.
paymentmethodOdczyt i zapisMetoda płatności:
cash - gotówka
transfer - przelew
compensation - kompensata
cod - za pobraniem
payment_card - kartą płatniczą
paymentdateOdczyt i zapisTermin płatności
paymentstateTylko do odczytuStan płatności:
paid - rozliczony
unpaid - nierozliczony
udefined - nieokreślony
disposaldate_formatOdczyt i zapisFormat daty sprzedaży na wydruku innego przychodu:
month - miesiąc sprzedaży
day - dzień sprzedaży
disposaldate_emptyOdczyt i zapisPrzy sprzedaży wysyłkowej nie jest znana data dostawy. W takim przypadku należy ustawić wartość 1 disaposaldate i uzupełnić datę dostawy przy osobnej akcji rozliczenia dostawy (moduł invoice_deliveries). Opcja dotyczy sprzedaży po 1 stycznia 2014 roku.
disposaldateOdczyt i zapisData sprzedaży
dateOdczyt i zapisData wystawienia innego przychodu
periodTylko do odczytuOkres w którym dokument jest widoczny na liście
alreadypaidTylko do odczytuKwota zapłacono uwzględniająca wszystkie płatności
alreadypaid_initialOdczyt i zapisKwota zapłacono określona przy dodawaniu i modyfikowaniu innego przychodu. Kwota jest widoczna na wydruku innego przychodu.
remainingTylko do odczytuKwota pozostało do zapłaty
typeOdczyt i zapisTyp dokumentu - income_bill
correction_typeTylko do odczytuPole wykorzystywane wewnętrznie przy fakturach korygujących
correctionsTylko do odczytuLiczba korekt
Waluta
currencyOdczyt i zapisWaluta
currency_exchangeTylko do odczytuKurs księgowy innego przychodu
currency_labelTylko do odczytuNumer tabeli NBP kursu księgowego
currency_dateTylko do odczytuData opublikowania kursu
price_currency_exchangeTylko do odczytuKurs stosowany przy przeliczaniu cen w panelu wfirmy
good_price_group_currency_exchangeTylko do odczytuKurs grupy cenowej stosowany przy przeliczaniu cen w panelu wfirmy
templateOdczyt i zapisIdentyfikator szablonu wydruku innego przychodu
auto_sendOdczyt i zapisAutomatyczna wysyłka faktury na maila kontrahenta
descriptionOdczyt i zapisUwagi
headerTylko do odczytuDodatkowe informacje w nagłówku innego przychodu. Wartość określana automatycznie na podstawie ustawień.
footerTylko do odczytuDodatkowe informacje w stopce innego przychodu. Wartość określana automatycznie na podstawie ustawień.
user_nameTylko do odczytuImię i nazwisko osoby upoważnionej do wystawienia innego przychodu. Wartość określana automatycznie na podstawie ustawień.
register_descriptionOdczyt i zapisDomyślnie faktury i inne dokumenty są księgowane do ewidencji z opisem sprzedaż towarów i usług. Możliwe jest określenie własnego opisu.
signedTylko do odczytuOznaczenie faktur podpisanych elektronicznie
id_externalOdczyt i zapisPole do zapisywania własnych wartości
notesTylko do odczytuLiczba notatek powiązanych z innym przychodem
documentsTylko do odczytuLiczba dokumentów powiązanych z innym przychodem
tagsOdczyt i zapisZnaczniki powiązane z innym przychodem w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

Zapytanie do akcji /invoices/add

Odpowiedź

Zapytanie do akcji /invoices/download/ID_FAKTURY

invoicecontents

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameOdczyt i zapisNazwa towaru lub usługi
classificationOdczyt i zapisPKWiU
unitOdczyt i zapisJednostka
countOdczyt i zapisIlość
priceOdczyt i zapisCena netto lub brutto w zależności od wartości w polu price_type faktury
discountOdczyt i zapisW przypadku potrzeby zastosowania rabatu należy ustawić wartość 1
discount_percentOdczyt i zapisProcent rabatu dla 50% należy wprowadzić wartość 50
nettoTylko do odczytuWartość netto pozycji
bruttoTylko do odczytuWartość brutto pozycji
vatOdczyt i zapisStawka VAT
lumpcodeOdczyt i zapisStawka ryczałtu - pole obowiązkowe w przypadku prowadzenia Ewidencji Przychodów
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

invoice_descriptions

Akcje

  • find
  • get

invoice_deliveries

Rozliczanie dostaw dokumentów sprzedaży, które nie mają określonej daty sprzedaży (sprzedaż wysyłkowa z nieznaną, przyszłą datą dostawy). Dotyczy invoices z wartośćią 1 w polu disposaldate_empty.

Akcje

  • add
  • edit
  • delete
  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
dateOdczyt i zapisData dostawy
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

Zapytanie do akcji /invoice_deliveries/add

Odpowiedź

notes

Zarządzanie notatkami. Notatki można dodawać do obiektów, które posiadają pole notes.

Akcje

  • edit - modyfikacja notatki o podanym id
  • get - pobranie szczegółów notatki o podanym id
  • delete - usunięcie notatki o podanym id
  • add - dodanie notatki
  • find - pobranie listy notatek

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
object_nameOdczyt i zapisNazwa modułu do którego przypisana jest notatka. Nie ma możliwości edycji tego pola.
object_idOdczyt i zapisIdentyfikator wpisu do którego przypisana jest notatka. Nie ma możliwości edycji tego pola.
textOdczyt i zapisTreść notatki
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

Zapytanie do akcji /notes/add

Odpowiedź

payments

Akcje

  • add
  • edit
  • delete
  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
object_nameOdczyt i zapisNazwa modułu do którego przypisana jest płatność (invoice lub expense). Nie ma możliwości edycji tego pola.
object_idOdczyt i zapisIdentyfikator wpisu do którego przypisana jest płatność. Nie ma możliwości edycji tego pola.
valueOdczyt i zapisKwota płatności
socialTylko do odczytuPole wykorzystywane przy rozliczaniu deklaracji, które nie są dostępne w API2
healthTylko do odczytuPole wykorzystywane przy rozliczaniu deklaracji, które nie są dostępne w API2
labor_fundTylko do odczytuPole wykorzystywane przy rozliczaniu deklaracji, które nie są dostępne w API2
dateOdczyt i zapisData zapłaty
initialTylko do odczytuOznaczenie płatności głównej, dodanej przy wystawiniu/modyfikowaniu faktury
payment_methodOdczyt i zapisMetoda płatności
typeTylko do odczytu
payment_typeOdczyt i zapis
notesTylko do odczytuLiczba notatek powiązanych z obiektem
tagsOdczyt i zapisZnaczniki powiązane z obiektem w formacie (ID ZNACZNIKA X),(ID ZNACZNIKA Y)...
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

Zapytanie do akcji /payments/add

Odpowiedź

payment_cashboxes

Akcje

  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
series_id_kpTylko do odczytuSeria dla dokumentów KP
series_id_kwTylko do odczytuSeria dla dokumentów KW
series_id_kwzTylko do odczytuSeria dla dokumentów wniosków o zaliczkę
series_id_krzTylko do odczytuSeria dla dokumentów rozliczenia wniosków o zaliczkę
nameTylko do odczytuNazwa kasy
initTylko do odczytuWartość początkowa
currencyTylko do odczytuWaluta kasy
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

series

Akcje

  • add
  • edit
  • delete
  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameOdczyt i zapisNazwa serii
templateOdczyt i zapisWzorzec serii. Zasady tworzenia wzorców opisane są tutaj.
initnumberOdczyt i zapisNumer początkowy serii
typeOdczyt i zapisRodzaj dokumentów, dla których ma zastosowanie dana seria numeracji
resetOdczyt i zapisKiedy numer serii będzie resetowany
yearly - co rok
monthy - co miesiąc - wymagany znacznik [miesiąc]
daily - codziennie - wymagane znaczniki [miesiąc] i [dzień]
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

staff_calendar_work_absences

Akcje

  • find

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
startOdczyt i zapisData rozpoczęcia nieobecności
stopOdczyt i zapisData zakończenia nieobecności
typeOdczyt i zapisRodzaj nieobecności:
1 - urlop wypoczynkowy
2 - urlop wypoczynkowy na żądanie
3 - urlop bezpłatny
4 - urlop wychowawczy
5 - urlop macierzyński
6 - choroba
7 - urlop opieka nad dzieckiem
8 - opieka
9 - urlop okolicznościowy
11 - poszukiwanie pracy
12 - nieobecność nieusprawiedliwiona
13 - nieobecność usprawiedliwiona płatna
14 - nieobecność usprawiedliwiona bezpłatna
15 - inna nieobecność
holiday_acceptedOdczyt i zapisCzy urlop wypoczynkowy jest zatwierdzony
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

staff_employees

Akcje

  • find

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
visibilityOdczyt i zapisWidoczność
tax_department_nameOdczyt i zapisUrząd skarbowy
tax_department_codeOdczyt i zapisKod urzędu
firstnameOdczyt i zapisImię
lastnameOdczyt i zapisNazwisko
parentnameOdczyt i zapisNazwisko rodowe
secondnameOdczyt i zapisDrugie imię
fathernameOdczyt i zapisImię ojca
mothernameOdczyt i zapisImię matki
peselOdczyt i zapisPESEL
nipOdczyt i zapisNIP
identity_cardOdczyt i zapisNumer dowodu
passportOdczyt i zapisNumer paszportu
birth_dateOdczyt i zapisData urodzenia
birth_placeOdczyt i zapisMiejsce urodzenia
citizenshipOdczyt i zapisObywatelstwo
sexOdczyt i zapisPłeć
bank_nameOdczyt i zapisNazwa banku
bank_accountOdczyt i zapisNumer rachunku
insurance_code_retiringOdczyt i zapisUprawnienia do emetytury lub renty
insurance_code_disabledOdczyt i zapisStopień niepełnosprawności
insurance_identity_typeOdczyt i zapisTyp identyfikatora dla ZUS
insurance_identity_numberOdczyt i zapisIdentyfikator dla ZUS
nfz_codeOdczyt i zapisOddział NFZ
emailOdczyt i zapisAdres e-mail
phoneOdczyt i zapisNumer telefonu
address_staff_employee_mainOdczyt i zapisAdres zameldowania:
street - ulica
building_number - numer budynku
flat_number - numer mieszkania
zip - kod pocztowy
city - miasto
commune - dzielnica
district - powiat
voivodeship - województwo
post - poczta
country_code - kod kraju
country_name - nazwa kraju
address_staff_employee_liveOdczyt i zapisAdres zamieszkania:
street - ulica
building_number - numer budynku
flat_number - numer mieszkania
zip - kod pocztowy
city - miasto
commune - dzielnica
district - powiat
voivodeship - województwo
post - poczta
country_code - kod kraju
country_name - nazwa kraju
address_staff_employee_contactOdczyt i zapisAdres kontaktowy:
street - ulica
building_number - numer budynku
flat_number - numer mieszkania
zip - kod pocztowy
city - miasto
commune - dzielnica
district - powiat
voivodeship - województwo
post - poczta
country_code - kod kraju
country_name - nazwa kraju
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

tags

Akcje

  • add - dodanie etykiety
  • edit - modyfikacja etykiety
  • delete - usunięcie etykiety na podstawie ID
  • find - pobranie listy etykiet
  • get - pobranie szczegółów etykiety na podstawie ID

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameOdczyt i zapisNazwa etykiety
color_backgroundOdczyt i zapisKolor tła w notacji heksadecymalnej np ff0000
colorOdczyt i zapisKolor w notacji heksadecymalnej np ff0000
Czy w danym miejscu będzie dostępna etykieta (wartości 1 - Tak, 0 - Nie)
invoiceOdczyt i zapisFaktury
expenseOdczyt i zapisWydatki
goodOdczyt i zapisProdukty
contractorOdczyt i zapisKontrahenci
contactOdczyt i zapisKontakty
documentOdczyt i zapisDokumenty
paymentOdczyt i zapisPłatności
staff_employeeOdczyt i zapisPracownicy
staff_contract_headerOdczyt i zapisUmowy pracowników
staff_salaryOdczyt i zapisListy płac
staff_contract_civil_billOdczyt i zapisRachunki do umów cywilnoprawnych
declaration_headerOdczyt i zapisDeklaracje
warehouse_documentOdczyt i zapisDokumenty magazynowe
payment_cashbox_documentOdczyt i zapisDokumenty kasowe
shop_transactionOdczyt i zapisTransakcje ze sklepu (moduł allegro)
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

Zapytanie do akcji /tags/add

Odpowiedź

translation_languages

Lista języków (wersji dwujęzycznych) faktur

Akcje

  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
nameTylko do odczytuNazwa wersji dwujęzycznej
codeTylko do odczytuKod drugiego języka
activeTylko do odczytuMożna używać tylko tych języków, które mają ustawioną wartość 1. Możliwe że w przyszłości pole zostanie zlikwidowane.
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

user_companies

Ustawienia użytkownika w firmie

Akcje

  • find
  • get

users

Akcje

  • get

vat_contents

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
object_nameTylko do odczytuInvoice
object_idTylko do odczytuId faktury
vat_code_idOdczyt i zapisZapis tylko przy fakturze z typem inny przychód
nettoOdczyt i zapisZapis tylko przy fakturze z typem inny przychód
taxOdczyt i zapisZapis tylko przy fakturze z typem inny przychód
bruttoOdczyt i zapisZapis tylko przy fakturze z typem inny przychód
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

vat_codes

Powiązane moduły

  • vat_code_periods (pełny, mnogi)

Akcje

  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
declaration_country_idTylko do odczytuIdentyfikator kraju dla zagranicznej stawki VAT, w przypadku Polski wartość 0
labelTylko do odczytu
rateTylko do odczytuStawka w procentach np 23
codeTylko do odczytuKod stawki, dotyczy tylko stawek krajowych. Przykładowe wartości WDT, ZW, 23.
typeTylko do odczytureduced - obniżona,
standard,
other - pozostałe
priorityTylko do odczytuKolejność na wydruku faktury w podsumowania VAT
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

vat_moss_details

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
object_nameTylko do odczytuInvoice
object_idTylko do odczytuId faktury
typeOdczyt i zapisKod rodzaju usługi elektronicznej. Dopuszczalne wartości SA, SB, SC, SD, SE, TA, TB, TC, TD, TE, TF, TG, TH, TJ, TK, BA, BB
evidence1_typeOdczyt i zapisKod dowodu potwierdzającego kraj nabywcy. Dopuszczalne wartości A, B, C, D, E, F
evidence1_descriptionOdczyt i zapisOpcjonalny opis dowodu
evidence2_typeOdczyt i zapisKod dowodu potwierdzającego kraj nabywcy. Dopuszczalne wartości A, B, C, D, E, F
evidence2_descriptionOdczyt i zapisOpcjonalny opis dowodu
createdTylko do odczytuData i godzina utworzenia wpisu
modifiedTylko do odczytuData i godzina zmodyfikowania wpisu

warehouses

Dostęp do listy magazynów

Akcje

  • find
  • get

webhooks

Żądanie musi zwracać status o kodzie "OK".

Akcje

  • add
  • edit
  • delete
  • find
  • get

Pola

Nazwa pola Przeznaczenie Opis
idTylko do odczytuKlucz główny
urlOdczyt i zapisAdres zwrotny
eventOdczyt i zapisTyp zdarzenia
invoice/add - wystawienie faktury
payments/add - dodanie płatności
warehouse_good/change_state - zmiana ilości produktu,
data_typeOdczyt i zapis xml, json,