API – Faktura proforma

POBIERANIE FAKTUR PROFORMA

Pobieranie faktur proforma: [GET] https://app.erpxt.pl/api2/public/v1.4/proformas

Opis struktury JSON odpowiedzi:

Parametr Opis
$id Numer porządkowy w ramach odpowiedzi JSON
PurchasingPartyId
 Id kontrahenta na dokumencie
ReceivingPartyId
 Id odbiorcy na dokumencie
PaymentTypeId
 Id formy płatności – do pobrania z zasobu API Formy płatności
BankAccountId
 Id rachunku bankowego
InvoiceType
 Algorytm obliczania (0 – od netto / 1 – od brutto)
OSSProcedureCountryCode
 Kod kraju dla procedury OSS – do pobrania ze słownika kodów krajów UE tutaj
IsOSSProcedure
 Oznaczenie procedury OSS (true / false)
InvoiceDocIdNum
 Id powiązanej faktury sprzedaży, faktury zaliczkowej lub powiązanego paragonu
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
Items Pozycje dokumentu
       $id Numer porządkowy w ramach odpowiedzi JSON
       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
       ProductDescription
 Opis produktu
       VatRateId
 Id stawki VAT – do pobrania ze słownika unijnych stawek VAT tutaj
       Id Id pozycji dokumentu w bazie danych
Description Opis dokumentu
IssueDate Data wystawienia dokumentu
Number Numer dokumentu
Status Status dokumentu: 0 – nieprzekształcony bezpośrednio do dokumentu sprzedażowego, 1 – przekształcony do faktury sprzedaży, faktury zaliczkowej lub paragonu
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,
    "InvoiceType": 0,
    "OSSProcedureCountryCode": "",
    "IsOSSProcedure": false,
    "InvoiceDocIdNum": null,
    "CurrencyCode": "PLN",
    "CurrencyRateType": 0,
    "CurrencyRateDate": "2023-04-04T00:00:00+02:00",
    "CurrencyConverter": 1.0,
    "CurrencyRate": 1.0,
    "Items": [
        {
            "ProductId": 130753,
            "Quantity": 1.0000,
            "ProductCurrencyPrice": 100.00,
            "ProductPrice": 100.00,
            "ProductName": "Mysz komputerowa przewodowa",
            "ProductDescription": "",
            "UnitOfMeasurement": "szt.",
            "VatRateId": 9,
            "Id": 375496
        }
    ],
    "Description": "",
    "IssueDate": "2023-04-05T00:00:00+02:00",
    "Number": "PF/23/4/2",
    "Status": 0,
    "Id": 278254
}
Przykład
Lista faktur proforma, które zostały przekształcone do faktury sprzedaży, faktury zaliczkowej lub paragonu: [GET] https://app.erpxt.pl/api2/public/v1.4/proformas/?$filter=InvoiceDocIdNum ne null

 

Możliwe jest także pobranie danych na temat określonego dokumentu faktury proforma:

[GET] https://app.erpxt.pl/api2/public/v1.4/proformas/XXX (gdzie XXX to Id dokumentu proforma w bazie danych)

Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/v1.4/proformas/2901092

Wskazówka
W API obsługiwane są faktury proforma w walucie PLN. W walucie obcej dostępne jest tylko pobieranie faktur. Nie są obsługiwane dokumenty anulowane.

DODAWANIE NOWEGO DOKUMENTU FAKTURY PROFORMA

Dodawanie faktury proforma: [POST] https://app.erpxt.pl/api2/public/v1.4/proformas

Wskazówka
Faktury proforma dodawane do Comarch ERP XT poprzez API zawsze będą miały status „Zapisane”. Wszelkie dalsze przekształcenia należy wykonywać po zalogowaniu do aplikacji.

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
PurchasingPartyId
 Id kontrahenta na dokumencie Tak
ReceivingPartyId
 Id odbiorcy na dokumencie Nie
PaymentTypeId
 Id formy płatności Tak
BankAccountId
 Id rachunku bankowego Nie
InvoiceType
 Algorytm obliczania (0 – od netto / 1 – od brutto) Nie1
OSSProcedureCountryCode
 Kod kraju dla procedury VAT OSS Nie4
IsOSSProcedure
 Oznaczenie procedury VAT OSS Nie
Items Pozycje dokumentu Nie2
       ProductId Id produktu Tak
       Quantity Ilość Tak
       ProductCurrencyPrice Cena netto sprzedaży Tak
       ProductDescription
 Opis produktu Nie
       VatRateId
 Id stawki VAT Nie4
Description Opis dokumentu Nie
IssueDate Data wystawienia dokumentu Nie3

1) W przypadku braku oznaczenia algorytmu, domyślnie zostanie zastosowane obliczenie od netto.

2) Można wystawić dokument bez dodanych pozycji. Jeśli jednak Użytkownik zdecyduje się użyć sekcji „Items”, wówczas należy wypełnić pola obowiązkowe.

3) W przypadku braku daty w parametrach, ustawiana będzie data bieżąca.

4) Parametry należy określić w przypadku wskazania kontrahenta o statusie „Procedura OSS”.

Przykładowe zapytanie JSON:

{
    "PurchasingPartyId": 14458134,
    "PaymentTypeId": 10260089,
    "Items": [
         {
            "ProductId": 11521520,
            "Quantity": 10,
            "ProductCurrencyPrice": 100.00
        }
    ]
}

W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury proforma.

EDYCJA FAKTURY PROFORMA

Edycja faktury proforma: [PUT] https://app.erpxt.pl/api2/public/v1.4/proformas

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
PurchasingPartyId
 Id kontrahenta na dokumencie Tak
ReceivingPartyId
 Id odbiorcy na dokumencie Nie
PaymentTypeId
 Id formy płatności Tak
BankAccountId
 Id rachunku bankowego Nie
InvoiceType
 Algorytm obliczania (0 – od netto / 1 – od brutto) Nie
OSSProcedureCountryCode
 Kod kraju dla procedury VAT OSS Nie3
IsOSSProcedure
 Oznaczenie procedury VAT OSS Nie
Items Pozycje dokumentu Nie1
       ProductId Id produktu Tak
       Quantity Ilość Tak
       ProductCurrencyPrice Cena netto sprzedaży Tak
       ProductDescription
 Opis produktu Nie
       VatRateId
 Id stawki VAT Nie3
       Id Id pozycji dokumentu w bazie danych Nie2
Description Opis dokumentu Nie
IssueDate Data wystawienia dokumentu Nie
Id Id dokumentu w bazie danych Tak

1) Jeśli edytowana faktura zawiera pozycje.

2) W przypadku pominięcia numeru Id pozycji podczas operacji edycji, zostanie dodana kolejna pozycja do dokumentu ze wskazanymi parametrami.

3) Parametry należy określić w przypadku wskazania kontrahenta o statusie „Procedura OSS”.

Uwaga
W przypadku pominięcia parametrów nieobowiązkowych, zostaną one nadpisane domyślnymi lub pustymi wartościami.
Uwaga
Poprzez XT API można edytować jednie faktury bez przekształceń (Status = 0).

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

Przykładowe zapytanie JSON (zmiana ilości sztuk na proformie o Id=28964885):

{
    "PurchasingPartyId": 14458134,
    "PaymentTypeId": 10260089,
    "Items": [
        {
            "ProductId": 11521520,
            "Quantity": 20,
            "ProductCurrencyPrice": 120.00,
            "Id": 50081265
        }
    ],
    "Id": 28964885
}

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

 

USUWANIE FAKTURY PROFORMA

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

Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/proformas/2901094

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

Wskazówka
Opcja usuwania faktury proforma jest dostępna tylko dla dokumentów bez przekształceń.

 

Aby dowiedzieć się jak pobrać poprzez API wydruk faktury proforma: API – Wydruki.

 

 

Czy ten artykuł był pomocny?

Wyślij opnie