Free online invoicing software
Log in
Create an account
To renew your account, make a payment.
If you experience payment problems, contact us.
Home Account Advanceinvoice Annotation Bank Bill CashPayout CashReceipt Cat Client ClientAddress ClientBank ClientBranch ClientDesignation ClientDocData ClientPerson Color Config ConfigDoc Corrective CorrectiveData CorrectiveEdit CorrectivePayDate CorrectiveProduct CorrectiveSendDate CorrectiveSendSMSDate Country Currency Data Delivery Footer Internalproof Invoice InvoiceData InvoiceEdit InvoicePayDate InvoiceProduct InvoiceSendDate InvoiceSendSMSDate Invoicemargin Invoicenovat Invoicerr Mail NoteCash NoteCashData NoteCashDebit NoteCashEdit NoteCashEndorsement NoteCashPayDate NoteCashPosition NoteCashSendDate NoteCashSendSMSDate NoteCorrective NoteCorrectiveData NoteCorrectiveEdit NoteCorrectivePosition NoteCorrectiveSendDate NoteCorrectiveSendSMSDate Number Offer Order OrderData OrderEdit OrderPayDate OrderProduct OrderSendDate OrderSendSMSDate PayKind PayTime Phone Postscript Producer Product Proforma Proof ProofData ProofEdit ProofProduct ProofSendDate ProofSendSMSDate Receipt Sign Status Tpl Unit User Vat Wz

Afaktury.pl API

On this page, you can access the API for the section Faktura proforma

Proforma Faktura proforma 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 dateCreate YES Date NO - - Data utworzenia number YES String NO 0 63 Numer dokumentu place NO String NO 0 31 Miejsce wystawienia annotation NO String NO 0 65535 Adnotacja info NO String NO 0 65535 Informacje dodatowe footer NO String NO 0 65535 Stopka footerIconPath1 NO String NO 0 63 Ścieżka do pierwszej grafiki stopki footerIconPath2 NO String NO 0 63 Ścieżka do drugiej grafiki stopki footerIconPath3 NO String NO 0 63 Ścieżka do trzeciej grafiki stopki documentHeader NO String NO 0 65535 Nagłowek dokumentu documentFooter NO String NO 0 65535 Stopka dokumentu documentInfo NO String NO 0 65535 Infomracje dokdatkowe dokumentu logoPath NO String NO 0 255 Ścieżka do logo signPath NO String NO 0 255 Ścieżka do podpisu personPut NO String NO 0 63 Osoba upoważniona do wystawienia personGet NO String NO 0 63 Osoba upoważniona do odbioru language YES String NO 0 7 Język typeJPK NO String NO 0 7 client NO client YES - - Klient data YES data YES - - Zestaw danych postscript NO postscript YES - - Dopisek status NO status YES - - Status personBuy YES Object (InvoiceData) NO - - Sprzedawca personSell NO Object (InvoiceData) NO - - Nabywca sendMailDates NO Array (InvoiceSendDate) NO - - Daty wysłania wiadomości e-mail sendSMSDates NO Array (InvoiceSendSMSDate) NO - - Daty wysłania wiadomości SMS editDates NO Array (InvoiceEdit) NO - - Daty edycji dokumentu hash NO String NO 0 10 HASH dateSell NO Date NO - - Data sprzedaży dateEnd NO Date NO - - Data zakończenia noOrder NO String NO 0 63 Numer zamówienia netto NO Float NO -2147483647 2147483647 Suma Netto vat NO Float NO -2147483647 2147483647 Suma VAT brutto NO Float NO -2147483647 2147483647 Suma Brutto payed NO Float NO -2147483647 2147483647 Zapłacono toPay NO Float NO -2147483647 2147483647 Pozostało do zapłaty currency YES currency YES - - Waluta payKind YES payKind YES - - Sposób płatności payTime YES payTime YES - - Termin płatności delivery NO delivery YES - - Sposób dostawy personBranch NO Object (InvoiceData) NO - - Oddział personPay NO Object (InvoiceData) NO - - Płatnik products YES Array (InvoiceProduct) NO - - Pozycje payDates NO Array (apiInvoicePayDate) NO - - Daty wpłat exchangeCurrency NO currency YES - - Druga waluta exchangeRate NO Float NO 0 2147483647 Kurs waluty exchangeMulti NO Float NO 1 2147483647 Mnożnik waluty exchangeDate NO Date NO - - Data kursu exchangeNumber NO String NO 0 31 Numer kursu typeJPK NO String NO 0 15 procedureJPK NO Array NO - - vatKind_0 NO String NO 0 15 Typ VAT 0% [KR | WDT | EX] vatKind_NP NO String NO 0 15 Typ VAT NP [NP_I | NP_II] Nagłówki
afakturyToken=1234567890123456789012345678901234567890
afakturyId=12345678901;afakturyKey=12346567890abcdef
 Akcje Pobranie obiektu Metoda: GET URL: https://faktura/api/invoice Przykładowe dane: { "hash": "12345678ab" } Dodanie obiektu Metoda: POST URL: https://faktura/api/invoice Przykładowe dane: { "dateCreate": "2018-01-01", "dateSell": "2018-01-01", "dateEnd": "2018-01-01", "number": "1\/01\/2018", "place": "Warsaw", "noOrder": "1\/01\/2018", "language": "pl", "payKind": 1, "payTime": 1, "delivery": 1, "currency": 1, "payed": 100, "personBuy": { "name": "Buyer", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "personSell": { "name": "Seller", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "personBranch": { "name": "Branch", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "personPay": { "name": "Payer", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "products": [ { "name": "Product 1", "pkwiu": "PKWIU", "amount": 10, "netto": 100, "brutto": 123, "rebate": 10, "isCountable": 0, "JPKColumn": 0, "vat": 7, "unit": 1, "isInvoice": 0, "product": 1, "productNo": "123456", "GTUColumn": "GTU_01", "procedure": "WSTO_EE" }, { "name": "Product 2", "pkwiu": "PKWIU", "amount": 10, "netto": 100, "brutto": 100, "rebate": 0, "isCountable": 0, "JPKColumn": 0, "vat": 3, "unit": 1, "isInvoice": 0, "product": 2, "productNo": "", "GTUColumn": "GTU_05", "procedure": "WSTO_EE" } ], "personPut": "Issuing", "personGet": "Receiving", "annotation": "annotation", "info": "info", "footer": "footer", "footerIconPath1": "file\/footer\/icon1.jpg", "footerIconPath2": "file\/footer\/icon1.jpg", "footerIconPath3": "file\/footer\/icon1.jpg", "documentHeader": "document header", "documentFooter": "document footer", "documentInfo": "document info", "logoPath": "file\/account\/logo.jpg", "signPath": "file\/account\/sign.jpg", "client": 1, "data": 1, "postscript": 1, "status": 1, "exchangeCurrency": 2, "exchangeRate": 4.1709, "exchangeMulti": 1, "exchangeDate": "2017-12-29", "exchangeNumber": "251\/A\/NBP\/2017", "vatKind_NP": "NP_I", "vatKind_0": "KR" } Aktualizacja obiektu Metoda: PUT URL: https://faktura/api/invoice Przykładowe dane: { "hash": "12345678ab", "dateCreate": "2018-01-01", "dateSell": "2018-01-01", "dateEnd": "2018-01-01", "number": "1\/01\/2018", "place": "Warsaw", "noOrder": "1\/01\/2018", "language": "pl", "payKind": 1, "payTime": 1, "delivery": 1, "currency": 1, "payed": 100, "personBuy": { "name": "Buyer", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "personSell": { "name": "Seller", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "personBranch": { "name": "Branch", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "personPay": { "name": "Payer", "address": "Address", "nipKind": 0, "nip": "1234567890", "alternativeHeader": 0, "isVATPayer": 1, "phone": "012-1234567", "fax": "012-1234567", "mail": "[email protected]", "www": "http:\/\/address.com", "krs": "1234567890", "regon": "1234567890", "bankAccountFirstNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountFirstName": "National Bank", "bankAccountFirstBic": "BIC", "bankAccountFirstDescription": "Main account", "bankAccountSecondNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountSecondName": "National Bank", "bankAccountSecondBic": "BIC", "bankAccountSecondDescription": "Second account", "bankAccountThirdNumber": "01 2345 6789 0123 4567 8901 2345", "bankAccountThirdName": "National Bank", "bankAccountThirdBic": "BIC", "bankAccountThirdDescription": "Third account", "idcardNo": "AAA123456", "idcardDate": "2018-01-01", "idcardAuth": "Goverment", "pesel": "12345678901" }, "products": [ { "name": "Product 1", "pkwiu": "PKWIU", "amount": 10, "netto": 100, "brutto": 123, "rebate": 10, "isCountable": 0, "JPKColumn": 0, "vat": 7, "unit": 1, "isInvoice": 0, "product": 1, "productNo": "123456", "GTUColumn": "GTU_01", "procedure": "WSTO_EE" }, { "name": "Product 2", "pkwiu": "PKWIU", "amount": 10, "netto": 100, "brutto": 100, "rebate": 0, "isCountable": 0, "JPKColumn": 0, "vat": 3, "unit": 1, "isInvoice": 0, "product": 2, "productNo": "", "GTUColumn": "GTU_05", "procedure": "WSTO_EE" } ], "personPut": "Issuing", "personGet": "Receiving", "annotation": "annotation", "info": "info", "footer": "footer", "footerIconPath1": "file\/footer\/icon1.jpg", "footerIconPath2": "file\/footer\/icon1.jpg", "footerIconPath3": "file\/footer\/icon1.jpg", "documentHeader": "document header", "documentFooter": "document footer", "documentInfo": "document info", "logoPath": "file\/account\/logo.jpg", "signPath": "file\/account\/sign.jpg", "client": 1, "data": 1, "postscript": 1, "status": 1, "exchangeCurrency": 2, "exchangeRate": 4.1709, "exchangeMulti": 1, "exchangeDate": "2017-12-29", "exchangeNumber": "251\/A\/NBP\/2017", "vatKind_NP": "NP_I", "vatKind_0": "KR" } Usunięcie obiektu Metoda: DELETE URL: https://faktura/api/invoice Przykładowe dane: { "id": 1 } Pobranie listy obiektów Metoda: GET URL: https://faktura/api/invoice/list Przykładowe dane: { "page": 1, "count": 25, "sortItem": 0, "sortDir": "a", "letter": "a", "phrase": "phrase", "dateBegin": "2018-01-01", "dateEnd": "2018-12-30", "year": 2018, "month": 5, "product": "product", "payedKind": 0, "client": 1, "payKind": 1, "currency": 1, "data": 1, "user": 1 } 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 dateBegin: begin date of period dateEnd: end date of period year: year of period (not use with dateBegin and dateEnd) month: month of period (use with year) product: product searching phrase payedKind: payed status, posible: 0 - all, 1 - paid, 2 - not paid, 3 - outdate client: client ID payKind: pay kind ID currency: currency ID data: account data ID user: user ID Pobranie pliku PDF Metoda: GET URL: https://faktura/api/invoice/pdf Przykładowe dane: { "hash": "abcdefghij", "kind": 1, "tpl": "std", "lang": "pl", "configPrint": { "showPrice": 1, "visibleSign": 1, "visibleQrcode": 1, "visiblePayTime": 1, "visiblePkwiu": 1, "visibleCashWord": 1, "visibleDoubleCash": 1, "visibleDelivery": 1, "visiblePreventiveSeal": 1, "visibleCurrency": 1, "visibleConversion": 1, "visibleBankAccount": 1, "visibleVATPayer": 1, "visiblePaydate": 1, "visiblePayment": 1 } } kind: print kind: 1 - one copy, 2 - two copies, 3 - duplicate tpl: template name, avaliable: std, pro lang: language code (ISO639-1) configPrint: print configuration Dodanie płatności do dokumentu Metoda: PUT URL: https://faktura/api/invoice/pay Przykładowe dane: { "hash": "abcdefghij", "cash": 100, "date": "2018-01-01 12:00:00" } date: ISO8601 format Wyzerowanie płatności za dokument Metoda: PUT URL: https://faktura/api/invoice/payzero Przykładowe dane: { "hash": "abcdefghij" } Wysłanie wiadomości do dokumentu Metoda: PUT URL: https://faktura/api/invoice/sendmail Przykładowe dane: { "hash": "abcdefghij", "title": "E-mail subject", "body": "E-mail body", "mail": "[email protected]", "kind": 1, "lang": "pl", "sendToMe": 1, "configPrint": { "showPrice": 1, "visibleSign": 1, "visibleQrcode": 1, "visiblePayTime": 1, "visiblePkwiu": 1, "visibleCashWord": 1, "visibleDoubleCash": 1, "visibleDelivery": 1, "visiblePreventiveSeal": 1, "visibleCurrency": 1, "visibleConversion": 1, "visibleBankAccount": 1, "visibleVATPayer": 1, "visiblePaydate": 1, "visiblePayment": 1 } } kind: print kind: 1 - one copy, 2 - two copies, 3 - duplicate lang: language code (ISO639-1) sendToMe: send message copy to me configPrint: print configuration Wysłanie przypomnienia o zapłacie do dokumentu Metoda: PUT URL: https://faktura/api/invoice/sendreminder Przykładowe dane: { "hash": "abcdefghij", "title": "E-mail subject", "body": "E-mail body", "mail": "[email protected]", "kind": 1, "lang": "pl", "sendToMe": 1, "sendDocument": 1, "configPrint": { "showPrice": 1, "visibleSign": 1, "visibleQrcode": 1, "visiblePayTime": 1, "visiblePkwiu": 1, "visibleCashWord": 1, "visibleDoubleCash": 1, "visibleDelivery": 1, "visiblePreventiveSeal": 1, "visibleCurrency": 1, "visibleConversion": 1, "visibleBankAccount": 1, "visibleVATPayer": 1, "visiblePaydate": 1, "visiblePayment": 1 } } kind: message kind: 1 - reminder, 2 - last reminder, 3 - thanks lang: language code (ISO639-1) sendToMe: send message copy to me sendDocument: send PDF file with document configPrint: print configuration Wysłanie dokumentów do księgowej Metoda: PUT URL: https://faktura/api/invoice/sendtoaccountant Przykładowe dane: { "ids": [ "abcdefghij", "9876543210" ], "title": "E-mail subject", "body": "E-mail body", "mail": "[email protected]", "kind": 1, "lang": "pl" } kind: message kind: 1 - reminder, 2 - last reminder, 3 - thanks lang: language code (ISO639-1) Wysłanie dokumentu do KSeF Metoda: PUT URL: https://faktura/api/invoice/ksef Przykładowe dane: { "hash": "12345678ab" }

Please wait...
January|February|March|April|May|June|July|August|September|October|November|December
Mon|Tue|Wed|Thu|Fri|Sat|Sun
Remove date
SEND FEEDBACK
Internal service error, code E01. Please contact technical support.
The most common cause of this error is a lost internet connection. Refresh the current webpage.
If the problem persists, contact us.
The action was completed successfully.
You are not the owner of this item.
Invalid data: incorrect Tax ID or account number
You do not have permission to perform this action.
This field cannot be empty.
No results.
The verification code is incorrect
Internal service error, code E04. Please contact technical support.
The form could not be sent. Check that all required fields have been completed
S1a8D8drGlfq9YMFcONTUHWOyB6ilaXG/wR6SgaBHwNKOqk46hMG+8ruoMAqXNwG
The account is awaiting two-factor authentication confirmation