POBIERANIE FAKTUR KORYGUJĄCYCH
Pobieranie faktur sprzedaży: [GET] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices
Opis struktury JSON odpowiedzi:
| Parametr | Opis |
| $id | Numer porządkowy w ramach odpowiedzi JSON |
|
PurchasingPartyId
|
Id nabywcy na dokumencie |
|
PurchasingParty
|
Dane nabywcy na dokumencie (CustomerType: 0 – osoba fizyczna, 1 – podmiot gospodarczy) |
|
ReceivingPartyId
|
Id odbiorcy na dokumencie |
|
ReceivingParty
|
Dane odbiorcy na dokumencie (CustomerType: 0 – osoba fizyczna, 1 – podmiot gospodarczy) |
|
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 |
|
BankAccountId
|
Id rachunku bankowego |
|
BankAccountNumber
|
Numer rachunku bankowego |
|
SalesDate
|
Data sprzedaży |
|
InvoiceType
|
Algorytm obliczania (0 – od netto / 1 – od brutto) |
|
PaymentStatus
|
Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo) |
| OSSProcedureCountryCode | Kod kraju dla procedury OSS – do pobrania ze słownika kodów krajów UE tutaj |
| IsOSSProcedure | Oznaczenie procedury OSS (true / false) |
| CorrectedId | Id dokumentu korygowanego |
| CorrectionReasonText | Przyczyna korekty |
| Items | Pozycje dokumentu |
| $id | Numer porządkowy w ramach odpowiedzi JSON |
| ProductId | Id produktu |
| Quantity | Ilość |
| ProductCurrencyPrice | Cena sprzedaży |
| ProductName | Nazwa produktu |
|
ProductDescription
|
Opis produktu |
|
UnitOfMeasurement
|
Jednostka miary |
|
VatRateId
|
Id stawki VAT – do pobrania ze słownika unijnych stawek VAT tutaj, pole jest powiązane również z procedurą OSS |
|
CorrectedId
|
Id pozycji korygowanej w bazie danych (pozycji na dokumencie korygowanym) |
| Id | Id pozycji dokumentu w bazie danych |
| Description | Opis dokumentu |
| IssueDate | Data wystawienia dokumentu |
| Number | Numer dokumentu |
| Status | Status dokumentu (0 – dokument w buforze / 1 – dokument zatwierdzony na stałe) |
| Id | Id dokumentu w bazie danych |
Przykładowa odpowiedź JSON:
DODAWANIE NOWEGO DOKUMENTU FAKTURY KORYGUJĄCEJ
Dodawanie faktury korygującej: [POST] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices?documentId=XXX (gdzie XXX to Id dokumentu faktury korygowanej w bazie danych)
W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury korygującej z wartościami identycznymi jak na fakturze korygowanej. W kolejnym kroku należy przy wykorzystaniu metody [PUT] nanieść odpowiednie modyfikacje wynikające z procesu korygowania dokumentu.
EDYCJA FAKTURY KORYGUJĄCEJ
Edycja faktury sprzedaży: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices
Opis struktury JSON zapytania:
| Parametr | Opis | Czy parametr obowiązkowy? |
|
PaymentStatus
|
Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie) | Nie |
|
PaymentTypeId
|
Id formy płatności | Tak |
|
PaymentDeadline
|
Termin płatności | Nie |
|
BankAccountId
|
Id rachunku bankowego | Nie |
|
SalesDate
|
Data sprzedaży | Nie |
| Items | Pozycje dokumentu | Nie, chyba że korekta dotyczy pozycji (korygowana jest ilość, cena netto stawka VAT lub opis) – wtedy należy podać wszystkie poniższe parametry |
| ProductId | Id produktu | Nie, jw. |
| Quantity | Ilość | Nie, jw. |
| ProductCurrencyPrice | Cena sprzedaży | Nie, jw. |
|
ProductDescription
|
Opis produktu | Nie, jw. |
|
VatRateId
|
Id stawki VAT – do pobrania ze słownika stawek VAT tutaj | Nie, jw. |
| Id | Id pozycji dokumentu w bazie danych | Nie, jw. |
| Description | Opis dokumentu | Nie |
| CorrectionReasonText | Przyczyna korekty | Nie |
| IsOSSProcedure | Oznaczenie procedury OSS (true / false) | Nie |
| IssueDate | Data wystawienia dokumentu | Nie |
| Id | Id dokumentu w bazie danych | Tak |
W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi.
Przykładowe zapytanie JSON (zwrot towaru, faktura korygująca o Id=23323962):
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
ZATWIERDZANIE FAKTUR KORYGUJĄCYCH
Zatwierdzanie faktur korygujących: [PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices/confirm
W odpowiedzi zostanie wysłany status i JSON odpowiedzi.
Przykładowe zapytanie JSON:
Przykładowa odpowiedź JSON:
USUWANIE FAKTURY KORYGUJĄCYCH
Usuwanie faktury korygującej: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices/XXX (gdzie XXX to Id dokumentu faktury korygującej w bazie danych)
Przykładowe zapytanie: [DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveinvoices/23324066
Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.
Aby dowiedzieć się jak pobrać wydruk faktury korygującej poprzez API – kliknij tutaj.
KOREKTY DO FAKTUR ZALICZKOWYCH
W przypadku dokumentów korygujących do faktur zaliczkowych należy skorzystać z analogicznych metod jak opisane powyżej dla faktur sprzedaży:
[GET] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices
[POST] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices?documentId=XXX
[PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices
[PUT] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices/confirm
[DEL] https://app.comarchbetterfly.pl/api2/public/v1.3/correctiveadvanceinvoices/XXX
W odróżnieniu od korekt do faktur sprzedaży, w przypadku korekt do faktur zaliczkowych nie można edytować ilości, ceny oraz stawki VAT produktów.