Client
Kontrahent
Pola
Nazwa
czy jest obowiązkowy
typ
klucz obcy
min. wartość/długość
max. wartość/długość
opis
id
NO
Int
NO
1
2147483647
ID
nameShort
NO
String
NO
0
31
Skrócona nazwa
name
YES
String
NO
1
255
Nazwa kontrahenta
nip
YES
String
NO
1
31
Number NIP
clientNumber
NO
String
NO
0
31
Numer klienta
deliveryNumber
NO
String
NO
0
31
Numer dostawy
phone
NO
String
NO
0
31
Numer telefonu
fax
NO
String
NO
0
31
Number fax'u
mail
NO
String
NO
0
63
Adres e-mail
www
NO
String
NO
0
63
Adres WWW
krs
NO
String
NO
0
31
Numer KRS
regon
NO
String
NO
0
31
Numer REGON
mailSend
NO
String
NO
0
63
Adres e-mail do wysyłki
phoneSend
NO
String
NO
0
31
Numer telefonu do wysyłki SMS
rebate
NO
Float
NO
0
100
Wysokość rabatu
info
NO
String
NO
0
65535
Informacje dodatkowe
lang
NO
String
NO
0
7
Język
idcardNo
NO
String
NO
0
31
Seria i numer dowodu osobistego
idcardDate
NO
Date
NO
-
-
Data wydania dowodu osobistego
idcardAuth
NO
String
NO
0
127
Wydający dowód osobisty
pesel
NO
String
NO
0
15
Numer PESEL
geoLat
NO
Float
NO
0
31
Szerokość geograficzna
geoLon
NO
Float
NO
0
31
Długość geograficzna
documentNo
NO
String
NO
0
31
Number dokumentu
bank
NO
clientbank
YES
-
-
Konto bankowe
currency
NO
currency
YES
-
-
Waluta
country
NO
country
YES
-
-
Kraj
payTime
NO
payTime
YES
-
-
Termin płatności
payKind
NO
payKind
YES
-
-
Rodzaj płatności
delivery
NO
delivery
YES
-
-
Sposób dostawy
address
NO
clientaddress
YES
-
-
Adres
designation
NO
designation
YES
-
-
Tytuł
data
NO
data
YES
-
-
Zestaw danych
Nagłówki
afakturyToken=1234567890123456789012345678901234567890
afakturyId=12345678901;afakturyKey=12346567890abcdef
Akcje
Pobranie obiektu
Metoda:
GET
URL:
https://faktura/api/client
Przykładowe dane:
{
"id": 1
}
Dodanie obiektu
Metoda:
POST
URL:
https://faktura/api/client
Przykładowe dane:
{
"nameShort": "client short name",
"name": "client name",
"nip": "123-546-78-90",
"clientNumber": "123456789",
"deliveryNumber": "123456789",
"phone": "123-456-789",
"fax": "987-654-321",
"mail": "[email protected] ",
"www": "http:\/\/my-page.com",
"krs": "123456789",
"regon": "123456789",
"mailSend": "[email protected] ",
"phoneSend": "123-456-879",
"rebate": 10,
"info": "info",
"lang": "pl",
"idcardNo": "ABC 12345",
"idcardDate": "2017-01-01",
"idcardAuth": "President of Warsaw",
"pesel": "12345678901",
"geoLat": 20,
"geoLon": 50,
"documentNo": "123456789",
"bank": {
"id": 1
},
"currency": {
"id": 1
},
"country": {
"id": 1
},
"payTime": {
"id": 1
},
"payKind": {
"id": 1
},
"delivery": {
"id": 1
},
"address": {
"id": 1
},
"designation": {
"id": 1
},
"data": {
"id": 1
}
}
Aktualizacja obiektu
Metoda:
PUT
URL:
https://faktura/api/client
Przykładowe dane:
{
"id": 1,
"nameShort": "client short name",
"name": "client name",
"nip": "123-546-78-90",
"clientNumber": "123456789",
"deliveryNumber": "123456789",
"phone": "123-456-789",
"fax": "987-654-321",
"mail": "[email protected] ",
"www": "http:\/\/my-page.com",
"krs": "123456789",
"regon": "123456789",
"mailSend": "[email protected] ",
"phoneSend": "123-456-879",
"rebate": 10,
"info": "info",
"lang": "pl",
"idcardNo": "ABC 12345",
"idcardDate": "2017-01-01",
"idcardAuth": "President of Warsaw",
"pesel": "12345678901",
"geoLat": 20,
"geoLon": 50,
"documentNo": "123456789",
"bank": {
"id": 1
},
"currency": {
"id": 1
},
"country": {
"id": 1
},
"payTime": {
"id": 1
},
"payKind": {
"id": 1
},
"delivery": {
"id": 1
},
"address": {
"id": 1
},
"designation": {
"id": 1
},
"data": {
"id": 1
}
}
Usunięcie obiektu
Metoda:
DELETE
URL:
https://faktura/api/client
Przykładowe dane:
{
"id": 1
}
Pobranie listy obiektów
Metoda:
GET
URL:
https://faktura/api/client/list
Przykładowe dane:
{
"page": 1,
"count": 25,
"sortItem": 0,
"sortDir": "a",
"letter": "a",
"phrase": "phrase"
}
page:
page number
count:
records per page
sortItem:
sort by item
sortDir:
sort order, possible values: a - order ascending, d - order descending
letter:
first letter
phrase:
searching phrase
