Pobieranie płatności: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/paymentdetails
Opis struktury JSON odpowiedzi:
| Parametr | Opis |
| PaymentId | Id płatności |
| PaymentType | INCOME – faktura sprzedaży OUTCOME – faktura zakupu INCOME_TAX – zaliczki i deklaracje dotyczące podatku dochodowego TAX_OR_FEE – inne podatki i opłat (składki PPK) VAT – podatek VAT SOCIAL_INSURANCE – składki ZUS |
| DocumentNumber | Numer dokumentu |
| CorrectedDocumentId | Jeżeli płatność jest do korekty – Id dokumentu korygowanego |
| CorrectedDocumentType | Jeżeli płatność jest do korekty – typ dokumentu korygowanego, przyjmuje wartości zgodne z opisem do pola DocumentType |
| CorrectionReason | Jeżeli płatność jest do korekty – przyczyna korekty jeżeli uzupełniono na fakturze |
| CreationDate | Data utworzenia płatności |
| UpdateDate | Data ostatniej aktualizacji płatności |
| IssueDate | Data płatności/dokumentu |
| DueDate | Termin płatności |
| SenderTaxId | NIP nadawcy płatności |
| SenderName | Nazwa firmy nadawcy płatności |
| SenderAddress | Adres firmy nadawcy płatności |
| Street | Ulica |
| HouseNumber | Numer domu |
| ApartmentNumbe | Numer lokalu |
| ZipCode | Kod pocztowy |
| City | Miasto |
| Region | Województwo |
| RecipientTaxId | NIP odbiorcy płatności |
| RecipientName | Nazwa firmy odbiorcy płatności |
| RecipientAddress | Adres firmy odbiorcy płatności |
| Street | Ulica |
| HouseNumber | Numer domu |
| ApartmentNumbe | Numer lokalu |
| ZipCode | Kod pocztowy |
| City | Miasto |
| Region | Województwo |
| RecipientAccountNumber | Numer rachunku bankowego odbiorcy płatności (w formacie IBAN czyli z prefiksem kraju) |
| Amount | Kwota płatności/dokumentu |
| VatAmount | Kwota VAT z dokumentu |
| SplitPayment | Czy zastosowano Metodę Podzielonej Płatności: true – tak, false – nie |
| Payable | Czy podlega rozliczeniu: true – tak, status płatności Nie rozliczono lub Częściowo rozliczono false – nie, status płatności to Anulowany lub Całkowicie rozliczony |
| Currency | Waluta płatności |
| Balance | Kwota pozostająca do zapłaty |
| Title | Tytuł płatności (opis do banku) |
| DocumentType | Typ dokumentu źródłowego: Invoice – faktura sprzedaży zwykła lub finalna AdvanceInvoice – faktura zaliczkowa PurchaseInvoice – faktura zakupu CorrectiveInvoice – korekta do faktury sprzedaży CorrectiveAdvanceInvoice – korekta do faktury sprzedaży zaliczkowej CorrectiveFiscalReceipt – korekta do paragonu CorrectivePurchaseInvoice – korekta do faktury zakupu FiscalReceipt – paragon Receipt – rachunek VatSaleBook – faktura sprzedaży dodana bezpośrednio w Rejestrze sprzedaży VAT VatPurchaseBook – faktura zakupu dodana bezpośrednio w Rejestrze zakupów VAT Vat7Declaration – deklaracja VAT/JPK_V7 Pit36Advance – zaliczka na PIT-36 Pit36LAdvance – zaliczka na PIT-36L Pit36Declaration – deklaracja PIT-36 Pit36LDeclaration – deklaracja PIT-36L ProfitMarginInvoice – faktura sprzedaży VAT marża CorrectiveProfitMarginInvoice – korekta faktury sprzedaży VAT marża OpeningBalanceItem – bilansu otwarcia BookEntryItem – zapis księgowegy Cit8Advance – zaliczka na CIT-8 Cit8Declaration – deklaracja CIT-8 PPKContributions – składka PPK ViudoDeclaration – deklaracja VIU-DO Pit28Advance – zaliczka na PIT-28 Pit28Declaration – deklaracja PIT-28 CostBook – dokument w Ewidencji Dodatkowej Kosztów RevenueBook – dokument w Ewidencji Dodatkowej Przychodów None – płatności zaimportowane z Optimy przez IWD |
Przykładowa odpowiedź JSON:
[code_snippet id=44]
Możliwe jest także pobranie szczegółów dla jednej płatności:
[GET] https://app.comarchbetterfly.pl/api2/public/v1.4/paymentdetails/XXX (gdzie XXX to Id płatności w bazie danych)
Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/paymentdetails/2692651
Przykładowa odpowiedź JSON:
[code_snippet id=45]
Pobieranie statusu płatności: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/payments
W zapytaniu należy podać Id płatności, które mają zostać pobrane
W odpowiedzi zostanie wysłany status płatności.
| Parametr | Opis |
| PaymentId | Id płatności |
| PaymentStatus | 0 – nierozliczona 1 – częściowo rozliczona 2 – całkowicie rozliczona 4 – do dokumentu anulowanego 5 – anulowana |
| Amount | Kwota płatności/dokumentu |
| Balance | Kwota pozostająca do zapłaty w walucie płatności, dla płatności anulowanej: 0 |
| Currency | Waluta dokumentu/płatności |
[code_snippet id=46]
Możliwe jest także pobranie statusu dla jednej płatności:
[GET] https://app.comarchbetterfly.pl/api2/public/v1.4/payments/XXX (gdzie XXX to Id płatności w bazie danych)
Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.4/payments/2692651
Przykładowa odpowiedź JSON:
[code_snippet id=47]
Aktualizacja statusu płatności: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.4/payments
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
| PaymentIds | Identyfikator płatności, które ma zostać rozliczone. Można podać więcej niż jedną płatność oddzielając Id przecinkami. Oznacza to, że dana wpłata będzie rozliczała więcej dokumentów. Kolejność rozliczania wg kolejności przesłanych Id płatności. | Tak |
| Cancelled | Czy płatność anulowana: true – tak, false – nie | Tak |
| PaymentDate | Data płatności | Tak, jeżeli Cancelled jest false |
| AmountPaid | Kwota zapłacona w walucie dokumentu, znak kwoty warunkuje kierunek płatności | Tak, jeżeli Cancelled jest false |
| BankAccountNumber | Rachunek bankowy: – dla wpłat – numer rachunku, na który przyszedł przelew, – dla wypłat – numer rachunku, z którego wyszedł przelew |
Tak, jeżeli Cancelled jest false |
| CurrencyCode | Symbol waluty | Nie |
| CurrencyRateType | Typ kursu waluty | Nie |
| CurrencyRateDate | Data kursu | Nie |
| CurrencyConverter | Mianownik kursu waluty | Nie |
| CurrencyRate | Licznik kursu waluty | Nie |
| CustomerBankAccountNumber | Rachunek bankowy: – dla wpłat – numer rachunku, na który przyszedł przelew, – dla wypłat – numer rachunku, z którego wyszedł przelew |
Nie |
| CustomerTIN | NIP kontrahenta | Nie |
| Description | Opis, tytuł płatności | Nie |
[code_snippet id=48]
W odpowiedzi JSON, mogą pojawić się następujące komunikaty błędów:
ErrorCode 0 – Płatność jest już rozliczona i nie może zostać anulowana.
ErrorCode 1 – Płatność jest już całkowicie rozliczona (jeżeli status całkowicie rozliczona)
ErrorCode 2 – Płatność nie podlega rozliczeniu (jeżeli inny status)
ErrorCode 3 – Kierunek płatności nie zgadza się z kierunkiem zapłaty
ErrorCode 4 – Waluta płatności różna od waluty zapłaty
ErrorCode 5 – W Comarch Betterfly nie ma rachunku o numerze …. Utwórz rachunek.
ErrorCode 6 – Nie można rozliczać niezatwierdzonych płatności
ErrorCode 7 – Płatność nie została rozliczona
ErrorCode 8 – Waluta przypisana do rachunku bankowego nie zgadza się z walutą aktualizowanej płatności.
[code_snippet id=49]
Zobacz także:
API – Historia zmian