Dokumentacja API - ifirma.pl


Wysyłanie faktur pocztą tradycyjną oraz na adres e-mail kontrahenta


Poprzez API możliwe jest wysłanie wystawionej faktury sprzedaży wiadomością e-mail do kontrahenta. W tym celu należy wysłać żądanie POST na jeden z poniższych adresów, w zależności od typu faktury:

  • faktura krajowa: https://www.ifirma.pl/iapi/fakturakraj/send/identyfikator_faktury.json
  • faktura wysyłkowa: https://www.ifirma.pl/iapi/fakturawysylka/send/identyfikator_faktury.json
  • faktura proforma: https://www.ifirma.pl/iapi/fakturaproformakraj/send/identyfikator_faktury.json
  • eksport towarów: https://www.ifirma.pl/iapi/fakturaeksporttowarow/send/identyfikator_faktury.json
  • WDT: https://www.ifirma.pl/iapi/fakturawdt/send/identyfikator_faktury.json
  • świadczenie usług dla podatników VAT-UE w trybie art. 28b: https://www.ifirma.pl/iapi/fakturaeksportuslugue/send/identyfikator_faktury.json
  • świadczenie usług poza terytorium kraju: https://www.ifirma.pl/iapi/fakturaeksportuslug/send/identyfikator_faktury.json
  • faktura wysyłkowa / krajowa w walucie obcej: https://www.ifirma.pl/iapi/fakturawaluta/send/identyfikator_faktury.json

gdzie identyfikator_faktury to identyfikator faktury uzyskany w odpowiedzi po poprawnym wystawieniu faktury, może zostać zastąpiony przez numer faktury (w numerze faktury ukośniki „/” należy zastąpić podłogami „_”, czyli np. 314/2014 to 314_2014).

Przykład z użyciem identyfikatora faktury:

https://www.ifirma.pl/iapi/fakturakraj/send/12354523.json

Przykład z użyciem numeru faktury:

https://www.ifirma.pl/iapi/fakturawysylka/send/12_4_2014.json

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

{
	"Tekst":"W załączeniu przesyłam fakturę dotyczącą zamówienia nr 258462",
	"Przelew": true,
	"Pobranie": true,
	"MTransfer":"mtransfer",
	"SkrzynkaEmail":"biuro@adressklepu.pl",
	"SzablonEmail":"zapisany_szablon"
}

gdzie:

  • Tekst – zawiera treść wiadomości przesyłanej do klienta, maksymalnie do 1000 znaków
  • Przelew – true – do treści wiadomości zostanie dodana informacja o możliwości zapłaty przelewem wraz z danymi do przelewu,
    false – brak informacji o możliwości zapłaty przelewem
  • Pobranie – true – do wiadomości zostanie dodana informacja o możliwości zapłaty za pobraniem
    false – brak informacji o możliwości zapłaty za pobraniem
  • MTransfer – do wiadomosci może zostać dodana opcja zapłaty przez mTransfer
  • SkrzynkaEmail – adres e-mail, z którego ma zostać wysłana wiadomość – wymaga wcześniejszej konfiguracji w ustawieniach konta ifirma.pl
  • SzablonEmail – nazwa szablonu treści wiadomości – wymaga wcześniejszej konfiguracji w ustawieniach konta ifirma.pl

Wskazanie adresu e-mail, z którego zostanie wysłana faktura

Możliwe jest wysłanie wyłącznie z adresów e-mail skonfigurowanych w serwisie. W przypadku braku dopasowania faktura zostanie wysłana z adresu zdefiniowanego jako domyślny.
Zmiana maila nadawcy przy wysyłce faktur

Użycie szablonu treści wiadomości

Wskazana nazwa szablonu powinna być zgodna z kongiguracją w serwisie. W przypadku braku dopasowania zostanie użyty zostanie szablon domyślny.
Wiadomość przesłana w żądaniu w polu Tekst zostanie doklejona do początku wiadomości.

Wysyłanie faktury elektronicznej (e-faktury)

Aby wysłać fakturę elektroniczną (e-fakturę), należy parametr wyslijEfaktura z wartością true dołączonyć do adresu.

Przykład adresu dla przesłania e-faktury krajowej:

https://www.ifirma.pl/iapi/fakturakraj/send/6255125.json?wyslijEfaktura=true

Wysyłanie faktury pocztą tradycyjną

Aby wysłać fakturę pocztą tradycyjną, należy parametr wyslijPoczta z wartością true dołączyć do adresu.

Przykład adresu dla przesłania faktury krajowej:

https://www.ifirma.pl/iapi/fakturakraj/send/57863485.json?wyslijPoczta=true

UWAGA
Parametr wyslijPoczta jest nadrzędny w stosunku do parametru wyslijEfaktura, tak więc użycie ich obu z wartością true spowoduje wysłanie faktury pocztą tradycyjną.


Copyright 2001-2018 ifirma.pl