API – Korekty

POBIERANIE FAKTUR KORYGUJĄCYCH

Pobieranie faktur sprzedaży: [GET] https://app.erpxt.pl/api2/public/v1.4/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 – do pobrania z zasobu API 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
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
DocumentCreatedByTaxPayer Dokument utworzony przez:
true – Płatnika VAT
false – Podatnika zwolnionego z VAT
Items Pozycje dokumentu
       ProductId Id produktu
       Quantity Ilość
       ProductCurrencyPrice Cena sprzedaży, po rabacie, w walucie dokumentu:
jeżeli InvoiceType = 0 – Cena sprzedaży netto
jeżeli InvoiceType = 1 – Cena sprzedaży brutto
 ProductPrice Cena sprzedaży, po rabacie
jeżeli InvoiceType = 0 – Cena sprzedaży netto
jeżeli InvoiceType = 1 – Cena sprzedaży brutto
       ProductName Nazwa produktu
       ProductDescription
 Opis produktu
       UnitOfMeasurement
 Jednostka miary
       VatRateId
 Id stawki VAT – do pobrania ze słownika unijnych stawek VAT tutaj
       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:

{
    "PurchasingPartyId": 125822,
    "PurchasingParty": {
        "Name": "COMARCH SPÓŁKA AKCYJNA",
        "NipPrefix": "",
        "Nip": "6770065406",
        "Country": "Polska",
        "City": "Kraków",
        "Street": "Aleja Jana Pawła II",
        "BuildingNumber": "39A",
        "FlatNumber": "4b",
        "BankName": "Bank Polska Kasa Opieki S.A. XI O. w Krakowie",
        "BankAccountNumber": "08 1240 4722 1111 0000 4851 1368",
        "CustomerType": 1
    },
    "ReceivingPartyId": null,
    "ReceivingParty": null,
    "PaymentTypeId": 4471,
    "PaymentType": 0,
    "PaymentDeadline": "2023-04-05T00:00:00+02:00",
    "BankAccountId": null,
    "BankAccountNumber": null,
    "SalesDate": "2023-04-05T00:00:00+02:00",
    "InvoiceType": 0,
    "PaymentStatus": 0,
    "OSSProcedureCountryCode": "",
    "IsOSSProcedure": false,
    "CorrectedId": 278251,
    "CorrectionReasonText": "Zwrot",
    "CurrencyCode": "PLN",
    "CurrencyRateType": 0,
    "CurrencyRateDate": "2023-04-04T00:00:00+02:00",
    "CurrencyConverter": 1.0,
    "CurrencyRate": 1.0,
    "DocumentCreatedByTaxPayer": true,
    "Items": [
        {
            "ProductId": 130753,
            "Quantity": 0.0,
            "ProductCurrencyPrice": 100.00,
            "ProductPrice": 100.00,
            "ProductName": "Mysz komputerowa przewodowa",
            "ProductDescription": "",
            "UnitOfMeasurement": "szt.",
            "VatRateId": 9,
            "CorrectedId": 375493,
            "Id": 375494
        }
    ],
    "Description": null,
    "IssueDate": "2023-04-05T00:00:00+02:00",
    "Number": "KOR/23/4/2",
    "Status": 1,
    "Id": 278252
}
Wskazówka
W API obsługiwane są korekty w walucie PLN. W walucie obcej dostępne jest tylko pobieranie korekt. Nie są obsługiwane dokumenty anulowane.

DODAWANIE NOWEGO DOKUMENTU FAKTURY KORYGUJĄCEJ

Dodawanie faktury korygującej: [POST] https://app.erpxt.pl/api2/public/v1.4/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.erpxt.pl/api2/public/v1.4/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
Uwaga
W przypadku pominięcia parametrów nieobowiązkowych, zostaną one nadpisane domyślnymi lub pustymi wartościami.
Uwaga
Poprzez interfejs API można edytować jednie faktury zapisane do bufora.

 

W odpowiedzi zostanie wysłany status i ewentualnie JSON odpowiedzi.

Przykładowe zapytanie JSON (zwrot towaru, faktura korygująca o Id=23323962):

{
    "PaymentTypeId": 1509,
    "CorrectedId": 1686883,
    "CorrectionReasonText": "",
    "Items": [
        {
            "ProductId": 438092,
            "Quantity": 1.0000,
            "ProductCurrencyPrice": 100.00,
            "ProductDescription": "",
            "VatRateId": 9,
            "Id": 4534062
        }
    ],
    "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.erpxt.pl/api2/public/v1.4/correctiveinvoices/confirm

W odpowiedzi zostanie wysłany status i JSON odpowiedzi.

Przykładowe zapytanie JSON: 
{
    "IdCollection": [
        1686874, 1686871
    ]
}
Przykładowa odpowiedź JSON: 
[
    {
        "Confirmed": true,
        "ErrorMessage": "",
        "ErrorCode": "",
        "DocumentNumber": "KOR/23/12/1",
        "DocumentId": 1686871
    },
    {
        "Confirmed": true,
        "ErrorMessage": "",
        "ErrorCode": "",
        "DocumentNumber": "KOR/23/12/2",
        "DocumentId": 1686874
    }
]

USUWANIE FAKTURY KORYGUJĄCYCH

Usuwanie faktury korygującej: [DEL] https://app.erpxt.pl/api2/public/v1.4/correctiveinvoices/XXX (gdzie XXX to Id dokumentu faktury korygującej w bazie danych)

Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/v1.4/correctiveinvoices/23324066

Przykładowa odpowiedź JSON – status 204 No Content – operacja zakończona powodzeniem.

Wskazówka
Opcja usuwania faktur korygujących jest dostępna tylko dla dokumentów będących w buforze.

 

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.erpxt.pl/api2/public/v1.4/correctiveadvanceinvoices

[POST] https://app.erpxt.pl/api2/public/v1.4/correctiveadvanceinvoices?documentId=XXX

[PUT] https://app.erpxt.pl/api2/public/v1.4/correctiveadvanceinvoices

[PUT] https://app.erpxt.pl/api2/public/v1.4/correctiveadvanceinvoices/confirm

[DEL] https://app.erpxt.pl/api2/public/v1.4/correctiveadvanceinvoices/XXX

Wskazówka
W przypadku faktur zaliczkowych dodatkowo zwracane jest pole dotyczące zaliczki: „CurrencyAdvance”. Pole jest możliwe do edycji.

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.

KOREKTY DO FAKTUR ZAKUPU

W przypadku dokumentów korygujących do faktur zakupu należy skorzystać z poniższych metod:

[GET] https://app.erpxt.pl/api2/public/v1.4/correctivepurchaseinvoices

[GET] https://app.erpxt.pl/api2/public/v1.4/correctivepurchaseinvoices/XXX (gdzie XXX to Id dokumentu)

Wskazówka
Możliwe jest tylko pobierania korekt do faktu zakupu w walucie PLN i w walucie obcej

Czy ten artykuł był pomocny?

Wyślij opnie