Dokumentacja API - ifirma.pl


Dodawanie kontrahenta


Nie jest konieczne dodawanie kontrahenta przed dodaniem dokumentu sprzedaży – w takim przypadku kontrahent zostanie utworzony na podstawie danych przesłanych w żądaniu zawierającym informacje o wystawianym dokumencie sprzedaży.

W celu dodania kontrahenta należy przesłać żądanie POST na adres:

https://www.ifirma.pl/iapi/kontrahenci.json

Klucz autoryzacji: FAKTURA

Przesyłane żądanie jest zestawem danych kontrahenta. Dostępne pola przedstwiono w tabeli poniżej.

Nazwa w JSON Typ danych Wartości Wymagane Opis
Nazwa String >= 1 znak;<= 150 znaków T Nazwa kontrahenta
Nazwa2 String <= 150 znaków N Nazwa kontrahenta c.d.
Identyfikator String <= 15 znaków;
null (zostanie wygenerowany automatycznie)
N Identyfikatora kontrahenta
PrefiksUE String <= 2 znaki N Prefiks UE kontrahenta
NIP String <= 13 znaków N NIP kontrahenta
Ulica String <= 65 znaków N Ulica z adresu siedziby kontrahenta
KodPocztowy String >= 1 znak;
<= 16 znaków
T Kod pocztowy z adresu siedziby kontrahenta
Kraj String <= 70 znaków N Kraj siedziby kontrahenta
Miejscowosc String >= 1 znak;
<= 65 znaków
T Miejscowość z adresu siedziby kontrahenta
AdresKorespondencyjnyUlica String <= 65 znaków N Ulica z adresu korespondencyjnego kontrahenta
AdresKorespondencyjnyKodPocztowy String >= 1 znak;
<= 16 znaków
N Kod pocztowy z adresu korespondencyjnego kontrahenta
AdresKorespondencyjnyKraj String <= 70 znaków N Kraj z adresu korespondencyjnego kontrahenta
AdresKorespondencyjnyMiejscowosc String >= 1 znak;
<= 65 znaków
N Miejscowość z adresu korespondencyjnego kontrahenta
Email String <= 65 znaków N Adres e-mail
EmailDlaFaktury String <= 65 znaków N Adres e-mail do przesyłania faktur (jeśli inny niż podstawowy)
Telefon String <= 32 znaki N Numer telefonu
DrugiTelefon String <= 32 znaki N Drugi numer telefonu
Faks String <= 32 znaki N Numer faksu
Skype String <= 32 znaki N
Www String <= 32 znaki N Adres strony www
NazwaBanku String <= 32 znaki N Nazwa banku, w którym jest konto bankowe kontrahenta
NumerKonta String <= 28 znaków N Numer konta kontrahenta
OsobaFizyczna Boolean true; false N Określa czy kontrahent jest osobą fizyczną.
domyslnie: false
PodmiotPowiazany Boolean true; false N Określa czy kontrahent jest podmiotem powiązanym ze sprzedawcą.
domyślnie: false
ZgodaNaEfaktury Boolean true; false N Określa czy kontrahent wyraził zgodę na efaktury
DataUdzieleniaZgody String Format: RRRR-MM-DD N Data wyrażenia zgody na efaktury
JestOdbiorca Boolean true; false N Określa czy kontrahent jest odbiorcą.
domyślnie: false
JestDostawca Boolean true; false N Określa czy kontrahent i sprzedawca są ze sobą powiązani.
domyślnie: false
Uwagi String N Uwagi odnośnie kontaktu z kontrahentem

Przykładowa zawartość żądania (JSON):

{
	"Nazwa": "Andrzej The Partymaker",
	"Identyfikator": null,
	"PrefiksUE": null,
	"NIP": "9871231212",
	"Ulica": "Czekoladowa 12",
	"KodPocztowy": "14-234",
	"Kraj": null,
	"Miejscowosc": "Miasteczko",
	"AdresKorespondencyjnyUlica": "Korespondencyjna 12",
	"AdresKorespondencyjnyKodPocztowy": "15-111",
	"AdresKorespondencyjnyKraj": null,
	"AdresKorespondencyjnyMiejscowosc": "Miasteczko korespondencyjne",
	"Email": "email@email.pl",
	"EmailDlaFaktury": "email_do_faktur@email.pl",
	"Telefon": "12131233",
	"DrugiTelefon": "21335464",
	"Faks": "12343245",
	"Skype": "IdentyfikatorSkype",
	"Www": "www.przykaldowyadres.pl",
	"NazwaBanku": "Milowy bank",
	"NumerKonta": "12 1234 1234 1234 1234 1234",
	"OsobaFizyczna": false,
	"PodmiotPowiazany": true,
	"JestOdbiorca": false,
	"JestDostawca": false,
	"ZgodaNaEfaktury": true,
	"DataUdzieleniaZgody" :"2019-02-02",
	"Uwagi": "Nie dzwonić po 19"
}

Po poprawnym przetworzeniu żądania zwracany jest kod wiadomości mówiący o poprawności wykonania żadania oraz identyfikator kontrahenta jako wynik:

{
	"response": {
		"Kod": 0,
		"Informacja": "Dodano kontrahenta",
		"Wynik": "124451232"
	}
}


Copyright 2001-2021 ifirma.pl