POBIERANIE FAKTUR ZAKUPU Z REJESTRU VAT ZAKUPU
Pobieranie faktur z rejestru VAT zakupu: [GET] https://app.comarchbetterfly.pl/api2/public/v1.8/vatpurchasebooks
Opis struktury JSON odpowiedzi:
| Parametr | Opis |
|
PaymentStatus
|
Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo) |
| CustomerId | Id dostawcy na dokumencie |
|
PaymentTypeId
|
Id formy płatności |
|
PaymentType
|
Typ płatności (0 – płatność gotówką, 1- płatność na konto, 2 – płatność kartą) |
|
PaymentDeadline
|
Termin płatności |
|
CustomerBankAccountNumber
|
Numer rachunku bankowego dostawcy |
| CustomerBankAccountName | Nazwa banku dostawcy |
|
BankAccountId
|
Id rachunku bankowego |
|
BankAccountNumber
|
Numer rachunku bankowego |
| PurchaseDate | Data zakupu |
|
NetTotal
|
Wartość netto dla całego dokumentu |
|
CurrencyNetTotal
|
Wartość netto w walucie obcej dla całego dokumentu |
|
GrossTotal
|
Wartość brutto dla całego dokumentu |
|
CurrencyGrossTotal
|
Wartość brutto w walucie obcej dla całego dokumentu |
|
VatTotal
|
Wartość VAT dla całego dokumentu |
|
CurrencyVatTotal
|
Wartość VAT w walucie obcej dla całego dokumentu |
|
CurrencyCode
|
Symbol waluty dokumentu |
|
CurrencyRateType
|
Typ kursu: 0 – Średni kurs NBP, 1 – kurs ręczny |
|
CurrencyRateDate
|
Data kursu waluty |
|
CurrencyConverter
|
Mianownik kursu walutowego |
|
CurrencyRate
|
Licznik kursu walutowego |
| Description | Opis dokumentu |
| IssueDate | Data wystawienia dokumentu |
| ReceiptDate | Data wpływu |
| Number | Numer obcy dokumentu |
| Correction | Oznaczenie czy faktura korygująca |
| CorrectedDocumentNumber | Numer korygowanej faktury |
| InternalDocument | Oznaczenie czy dokument wewnętrzny |
| IncludedInJPKV7 | Kwalifikacja dokumentu do deklaracji JPK_V7 |
| VATDeclatationDate | Rok i miesiąc, w którym faktura jest zakwalifikowana do JPK_V7 |
| IncludedInVATUE | Kwalifikacja dokumentu do deklaracji VAT-UE |
| VATUEDeclarationDate | Rok i miesiąc, w którym faktura jest zakwalifikowana do deklaracji VAT-UE |
|
JpkProceduresSymbols
|
Tablica kodów JPK_V7 |
|
KsefNumber
|
Numer KSeF |
|
KsefDate
|
Data przyjęcia dokumentu przez KSeF |
|
CategoryId
|
Identyfikator kategorii księgowej (słownik kategorii dostępny tutaj: Kategorie) |
|
AccountingDescription
|
Opis księgowy |
| Items | Pozycje dokumentu |
| VatRateId | Id stawki VAT – do pobrania ze słownika stawek VAT |
| ItemNetValue | Kwota netto na pozycji |
| ItemNetValueCurrency | Kwota netto na pozycji w walucie dokumentu |
| ItemVATValue | Kwota VAT na pozycji |
| ItemVATValueCurrency | Kwota VAT na pozycji w walucie dokumentu |
| ItemGrossValue | Kwota brutto na pozycji |
| ItemGrossValueCurrency | Kwota VAT na pozycji |
| FieldInJPKV7 | Pole w pliku JPK_V7. Oznaczenie słownika pola JPK_V7 wg poniższego klucza: 0 – Nie uwzględniaj w pliku JPK_V7 21 – (P_40) Nabycie środków trwałych 22 – (P_42) Nabycie pozostałe 24 – (P_44) Korekta podatku naliczonego od nabycia środków trwałych 25 – (P_45) Korekta podatku naliczonego od pozostałych nabyć |
| FieldInVATUE | Pole na deklaracji VAT-UE. Oznaczenie słownika pola VAT-UE wg poniższego klucza: 0 – Nie uwzględniaj w deklaracji 2 – D. Nabycie towarów |
| ItemType | Rodzaj produktu: 0 – usługa, 1 – towar |
| VAT50deduction | Czy odliczenie 50% VAT, 1 – tak, 0 – nie |
| PercentAsExpenses | Ile procent w koszty |
| AccountNumber | Numer konta księgowego |
| Id | Id pozycji dokumentu w bazie danych |
Przykładowa odpowiedź JSON:
{
"PaymentStatus": 0,
"CustomerId": 11972967,
"PaymentTypeId": 10260089,
"PaymentType": 0,
"PaymentDeadline": "2020-09-02T00:00:00+02:00",
"CustomerBankAccountNumber": "",
"CustomerBankAccountName": "",
"BankAccountId": null,
"BankAccountNumber": null,
"PurchaseDate": "2020-09-02T00:00:00+02:00",
"ReceiptDate": "2020-09-02T00:00:00+02:00",
"NetTotal": 100.00,
"CurrencyNetTotal": 100.00,
"GrossTotal": 123.00,
"CurrencyGrossTotal": 123.00,
"VatTotal": 23.00,
"CurrencyVatTotal": 23.00,
"CurrencyCode": "PLN",
"CurrencyRateType": 0,
"CurrencyRateDate": "2020-09-01T00:00:00+02:00",
"CurrencyConverter": 1.0,
"CurrencyRate": 1.0,
"Correction": false,
"InternalDocument": false,
"CorrectedDocumentNumber": "",
"IncludedInJPKV7": true,
"VATDeclarationDate": "2020-09",
"IncludedInVATUE": false,
"VATUEDeclarationDate": "2020-09",
"JpkProceduresSymbols": [
"B_SPV",
"MR_T"
],
"KsefNumber": "6876867676-12112122-B08D97982CC4-D0",
"KsefDate": "2026-07-24T14:49:17+02:00",
"CategoryId": 51748,
"AccountingDescription": "Artykuły Biurowe",
"Items": [
{
"VatRateId": 9,
"ItemNetValue": 100.00,
"ItemNetValueCurrency": 100.00,
"ItemVATValue": 23.00,
"ItemVATValueCurrency": 23.00,
"ItemGrossValue": 123.00,
"ItemGrossValueCurrency": 123.00,
"FieldInJPKV7": 22,
"FieldInVATUE": 0,
"ItemType": 0,
"VAT50deduction": 0,
"PercentAsExpenses": 100.0,
"AccountNumber": "",
"Id": 15758450
}
],
"Description": "Zakup towarów",
"IssueDate": "2020-09-02T00:00:00+02:00",
"Number": "1716",
"Id": 14785511
}
Możliwe jest także pobranie danych konkretnego dokumentu faktury zakupu:
[GET] https://app.comarchbetterfly.pl/api2/public/v1.8/vatpurchasebooks/XXX (gdzie XXX to Id dokumentu faktury zakupu w bazie danych)
Przykładowe zapytanie: [GET] https://app.comarchbetterfly.pl/api2/public/v1.8/vatpurchasebooks/14785511
EDYCJA KATEGORII DLA REJESTRU VAT ZAKUPU
Seryjna edycja kategorii w rejestrze vat zakupu: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.8/vatpurchasebooks/category
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
|
EntitiesIds
|
Identyfikatory rejestrów VAT zakupu. Operacja jest zbiorcza czyli można podać wiele dokumentów naraz. | Tak |
|
CategoryId
|
Identyfikator kategorii księgowej (słownik kategorii dostępny tutaj: Kategorie) | Tak |
Przykładowe zapytanie JSON (zmiana kategorii na zapisach w rejestrze VAT zakupu o Id=1283138, Id=1283123):
{
"EntitiesIds": [
1283138,
1283123
],
"CategoryId": 51813
}Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
EDYCJA OPISU KSIĘGOWEGO DLA REJESTRU VAT ZAKUPU
Seryjna edycja opisu księgowego w rejestrze vat zakupu: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.8/vatpurchasebooks/accountingdescription
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
| EntitiesIds | Identyfikatory rejestrów VAT zakupu. Operacja jest zbiorcza czyli można podać wiele dokumentów naraz. | Tak |
|
AccountingDescription
|
Opis księgowy do przypisania wskazanym dokumentom. Podanie null oznacza wyczyszczenie (usunięcie) opisu z tych dokumentów. | Tak |
Przykładowe zapytanie JSON (zmiana opisu księgowego na zapisach w rejestrze VAT zakupu o Id=1283138, Id=1283123):
{
"EntitiesIds": [
1283138,
1283123
],
"AccountingDescription": "Opis księgowy"
}Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
