API – Faktura sprzedaży wersja 1.1

POBIERANIE FAKTUR SPRZEDAŻY

Pobieranie faktur sprzedaży: [GET] https://app.erpxt.pl/api2/public/v1.1/invoices

Opis struktury JSON odpowiedzi:

Parametr Opis
$id Numer porządkowy w ramach odpowiedzi JSON
PaymentStatus Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie, 2 – zapłacona częściowo)
PurchasingPartyId
Id kontrahenta na dokumencie
ReceivingPartyId
Id odbiorcy na dokumencie
PaymentTypeId
Id formy płatności
BankAccountId
Id rachunku bankowego
SalesDate Data sprzedaży
InvoiceType
Algorytm naliczania (0 – od cen netto / 1 – od cen brutto)
Items Pozycje dokumentu
$id Numer porządkowy w ramach odpowiedzi JSON
ProductId Id produktu
Quantity Ilość
ProductCurrencyPrice Cena sprzedaży
      ProductDescription
Opis produktu
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:

[
    {
        „$id”: „1”,
        „PaymentStatus”: 0,
        „PurchasingPartyId”: 2558640,
        „ReceivingPartyId”: 2558641,
        „PaymentTypeId”: 2015207,
        „BankAccountId”: null,
        „SalesDate”: „2020-06-24T00:00:00+01:00”,
        „InvoiceType”: 1,
        „Items”: [
            {
                „$id”: „2”,
                „ProductId”: 2290304,
                „Quantity”: 1.0000,
                „ProductCurrencyPrice”: 169.99,
                „ProductDescription”: „”,
                „Id”: 4463601
            }
        ],
        „Description”: „Opis faktury”,
        „IssueDate”: „2020-06-24T00:00:00+01:00”,
        „Number”: „FS/20/6/1”,
        „Status”: 1,
        „Id”: 2760795
    },
   {
        „$id”: „2”,
        „PaymentStatus”: 0,
        „PurchasingPartyId”: 2558645,
        „ReceivingPartyId”: null,
        „PaymentTypeId”: 2015208,
        „BankAccountId”: null,
        „SalesDate”: „2020-07-28T00:00:00+01:00”,
        „InvoiceType”: 1,
        „Items”: [
            {
                „$id”: „4”,
                „ProductId”: 2290519,
                „Quantity”: 1.0000,
                „ProductCurrencyPrice”: 599.99,
                „ProductDescription”: „”,
                „Id”: 4464201
            }
        ],
        „Description”: null,
        „IssueDate”: „2020-07-28T00:00:00+01:00”,
        „Number”: „FS/20/7/25”,
        „Status”: 1,
        „Id”: 2761381
    }
]

 

Możliwe jest także pobranie danych dotyczących określonego dokumentu faktury sprzedaży:

[GET] https://app.erpxt.pl/api2/public/v1.1/invoices/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych)

Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/v1.1/invoices/2789863

Przykładowa odpowiedź JSON:

{
    „$id”: „1”,
    „PaymentStatus”: 1,
    „PurchasingPartyId”: 2567977,
    „ReceivingPartyId”: null,
    „PaymentTypeId”: 2015209,
    „BankAccountId”: 2004805,
    „SalesDate”: „2020-10-26T00:00:00+01:00”,
    „InvoiceType”: 0,
    „Items”: [
        {
            „$id”: „2”,
            „ProductId”: 2301251,
            „Quantity”: 10.0000,
            „ProductCurrencyPrice”: 112.00,
            „ProductDescription”: „”,
            „Id”: 4494377
        },
        {
            „$id”: „3”,
            „ProductId”: 2301251,
            „Quantity”: 10.0000,
            „ProductCurrencyPrice”: 112.00,
            „ProductDescription”: „”,
            „Id”: 4494378
        }
    ],
    „Description”: null,
    „IssueDate”: „2020-10-26T00:00:00+01:00”,
    „Number”: „FS/20/10/8”,
    „Status”: 0,
    „Id”: 2789863
}

 

Dostępna jest możliwość pobrania dokumentu o konkretnym numerze:

[GET] https://app.erpxt.pl/api2/public/v1.1/invoices/number/XXX (gdzie XXX to numer dokumentu)

Przykładowe zapytanie: https://app.erpxt.pl/api2/public/v1.1/invoices/number/FS/2021/1/6

Przykładowa odpowiedź JSON:

{
    „$id”: „1”,
    „PaymentStatus”: 1,
    „PurchasingPartyId”: 2541836,
    „ReceivingPartyId”: 2541748,
    „PaymentTypeId”: 2016674,
    „BankAccountId”: 2004259,
    „SalesDate”: „2021-01-07T00:00:00+01:00”,
    „InvoiceType”: 1,
    „Items”: [
        {
            „$id”: „2”,
            „ProductId”: 2276109,
            „Quantity”: 1.0000,
            „ProductCurrencyPrice”: 100.00,
            „ProductDescription”: „4526160”,
            „Id”: 4526160
        }
    ],
    „Description”: „2814943”,
    „IssueDate”: „2021-01-07T12:50:43+01:00”,
    „Number”: „FS/2021/1/6”,
    „Status”: 0,
    „Id”: 2814943
}
Wskazówka
W API obsługiwane są faktury sprzedaży w buforze. Dodatkowo można pobrać dane i wydruki dla faktur zatwierdzonych na stałe. Nie są obsługiwane faktury zaliczkowe, faktury finalne, dokumenty anulowane oraz korekty.
Wskazówka
W API obsługiwane są faktury w walucie PLN. Nie są obsługiwane faktury w walutach obcych.

DODAWANIE NOWEGO DOKUMENTU FAKTURY SPRZEDAŻY

Dodawanie faktury sprzedaży: [POST] https://app.erpxt.pl/api2/public/v1.1/invoices

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
PaymentStatus Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie)1 Nie1
PurchasingPartyId Id kontrahenta na dokumencie Tak
ReceivingPartyId Id odbiorcy na dokumencie Nie
PaymentTypeId Id formy płatności Tak
BankAccountId Id rachunku bankowego Nie
SalesDate Data sprzedaży w formacie RRRR-MM-DD Nie2
InvoiceType Algorytm naliczania (0 – od cen netto / 1 – od cen brutto) Nie3
Items Pozycje dokumentu Nie4
       ProductId Id produktu Tak
       Quantity Ilość Tak
       ProductNetPrice
Cena netto sprzedaży Tak
       ProductDescription
Opis produktu Nie
IssueDate Data wystawienia dokumentu w formacie RRRR-MM-DD Nie5

1) Status zapłaty podczas dodawania faktury sprzedaży może przyjmować jedynie wartość: 0 – niezapłacona lub wartość: 1 – zapłacona całkowicie. Status 2 – zapłacona częściowo jest możliwy do odnotowania jedynie z poziomu aplikacji Comarch ERP XT. W przypadku braku oznaczenia statusu płatności, domyślnie dokument zostanie oznaczony jako brak zapłaty (0).

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

3) W przypadku braku wartości w tym polu podstawiona będzie wartość domyślna dla dokumentu

4) 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.

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

Przykładowe zapytanie JSON:

{
    „PaymentStatus”: 1,
    „PurchasingPartyId”: 2567977,
    „ReceivingPartyId”: 2541748,
    „PaymentTypeId”: 2015209,
    „BankAccountId”: 2004805,
    „InvoiceType”: 1,
    „Items”: [
        {
            „ProductId”: 2301251,
            „Quantity”: 10.0000,
            „ProductCurrencyPrice”: 112.00,
            „ProductDescription”: „Opis dokumentu”,
            „Id”: 4494377
        }
    ]
}

W odpowiedzi zostanie wysłane ID dodanego dokumentu faktury sprzedaży.

Przykładowa odpowiedź:

2814937
Wskazówka
Podczas dodawania nowej faktury sprzedaży poprzez API, dokument będzie miał nadany numer zgodnie z domyślnym schematem numeracji, ustawionym w Comarch ERP XT.
Wskazówka
Faktury sprzedaży dodawane do Comarch ERP XT poprzez API zawsze będą miały status „Zapisane” (w buforze). Wszelkie dalsze operacje – np. zatwierdzenia i księgowania dokumentu – należy wykonywać po zalogowaniu do aplikacji.

EDYCJA FAKTURY SPRZEDAŻY

Edycja faktury sprzedaży: [PUT] https://app.erpxt.pl/api2/public/v1.1/invoices

Opis struktury JSON zapytania:

Parametr Opis Czy parametr obowiązkowy?
PaymentStatus Status płatności (0 – niezapłacona, 1 – zapłacona całkowicie) Tak
PurchasingPartyId Id kontrahenta na dokumencie Tak
ReceivingPartyId Id odbiorcy na dokumencie Nie
PaymentTypeId Id formy płatności Tak
BankAccountId Id rachunku bankowego Nie
SalesDate Data sprzedaży w formacie RRRR-MM-DD Nie
InvoiceType Algorytm naliczania (0 – od cen netto / 1 – od cen brutto) Nie2
Items Pozycje dokumentu Tak1
       ProductId Id produktu Tak
       Quantity Ilość Tak
       ProductCurrencyNetPrice
Cena netto sprzedaży Tak
       ProductDescription
Opis produktu Nie
       Id
ID pozycji dokumentu w bazie danych Nie3
IssueDate Data wystawienia dokumentu w formacie RRRR-MM-DD Nie
Id Id dokumentu w bazie danych Tak

1) Jeśli edytowana faktura zawiera pozycje.

2) W przypadku braku wartości w tym polu podstawiona będzie wartość domyślna dla dokumentu

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

Uwaga
W przypadku pominięcia parametrów nieobowiązkowych, zostaną one nadpisane domyślnymi lub pustymi wartościami.
Uwaga
Poprzez API można edytować jednie faktury zapisane do bufora.

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

Przykładowe zapytanie JSON:

{
    „PaymentStatus”: 1,
    „PurchasingPartyId”: 2567977,
    „ReceivingPartyId”: 2541748,
    „PaymentTypeId”: 2015209,
    „BankAccountId”: 2004805,
    „InvoiceType”: 1,
    „Items”: [
        {
            „ProductId”: 2301251,
            „Quantity”: 10.0000,
            „ProductCurrencyPrice”: 112.00,
            „ProductDescription”: „Opis dokumentu”,
            „Id”: 4494377
        }
    ],
    „Description”: null,
    „IssueDate”: „2020-10-26T00:00:00+01:00”,
    „Id”: 2814943
}

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

brak treści
Uwaga
Opcja edycji faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

USUWANIE FAKTURY SPRZEDAŻY

Usuwanie faktury sprzedaży: [DEL] https://app.erpxt.pl/api2/public/v1.1/invoices/XXX (gdzie XXX to Id dokumentu faktury sprzedaży w bazie danych)

Przykładowe zapytanie: [DEL] https://app.erpxt.pl/api2/public/v1.1/invoices/2814943

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

brak treści
Uwaga
Opcja usuwania faktury sprzedaży jest dostępna tylko dla dokumentów będących w buforze.

 

Aby dowiedzieć się jak pobrać wydruk faktury sprzedaży poprzez API – kliknij tutaj.

Czy ten artykuł był pomocny?