API – Przekształcanie faktur zaliczkowych

PRZEKSZTAŁCANIE FAKTUR ZALICZKOWYCH

W programie Comarch ERP XT można wystawić m.in.:

• jedną fakturę zaliczkową i przekształcić ją do jednej faktury finalnej
• wiele powiązanych faktur zaliczkowych i przekształcić je do jednej faktury finalnej
• wiele powiązanych faktur zaliczkowych i przekształcić je do wielu faktur finalnych

[POST] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/{id}/finalize?convertAll=false

Metoda pozwala na przekształcenie tylko wskazanej faktury zaliczkowej (id) do faktury finalnej.

Przykładowe zapytanie: [POST] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/2901096/finalize?convertAll=false

[POST] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/{id}/finalize?convertAll=true

Metoda pozwala na przekształcenie wskazanej faktury zaliczkowej (id) oraz wszystkich faktur z nią powiązanych do jednej faktury finalnej.

Przykładowe zapytanie: [POST] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/2901096/finalize?convertAll=true

W odpowiedzi przesyłana jest faktura finalna będąca efektem przekształcenia dokumentów.

Przykładowa odpowiedź JSON:

{
    "PaymentStatus": 0,
    "OSSProcedureCountryCode": "",
    "IsOSSProcedure": false,
    "IsFinal": true,
    "PurchasingPartyId": 529611,
    "PurchasingParty": {
        "Name": "COMARCH SPÓŁKA AKCYJNA",
        "NipPrefix": "",
        "Nip": "6770065406",
        "Country": "",
        "City": "Kraków",
        "Street": "Aleja Jana Pawła II",
        "BuildingNumber": "39 A",
        "FlatNumber": "",
        "BankName": "",
        "BankAccountNumber": "",
        "CustomerType": 1
    },
    "ReceivingPartyId": null,
    "ReceivingParty": null,
    "PaymentTypeId": 1509,
    "PaymentType": 1,
    "BankAccountId": 113,
    "BankAccountNumber": "76906810134600238781879677",
    "SalesDate": "2024-06-05T00:00:00+02:00",
    "InvoiceType": 0,
    "NetTotal": 71.30,
    "GrossTotal": 87.70,
    "VatTotal": 16.40,
    "Items": [
        {
            "ProductId": 2028,
            "Quantity": 1.0000,
            "ProductCurrencyPrice": 81.30,
            "ProductName": "Produkt 1",
            "ProductDescription": "",
            "UnitOfMeasurement": "szt.",
            "VatRateId": 9,
            "Id": 5548500
        }
    ],
    "Description": null,
    "IssueDate": "2024-06-05T00:00:00+02:00",
    "Number": "FS/24/6/4",
    "Status": 0,
    "Id": 1995428
}

Dodatkowo użytkownik może wcześniej sprawdzić czy dany dokument kwalifikuje się do przekształcenia do faktury finalnej metodą weryfikującą:

[GET] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/{id}/canFinalize?convertAll=true

Przykładowe zapytanie: [GET] https://app.erpxt.pl/api2/public/v1.2/advanceInvoices/2901096/canFinalize?convertAll=true

W odpowiedzi zostanie wysłana informacja true albo false.

W operacji przekształcania lub weryfikowania faktury zaliczkowej mogą pojawić się następujące komunikaty, które dotyczą ostatniego powiązanego dokumentu:

ErrorCode 1 – kontrahent jest zanonimizowany
ErrorCode 2 – dokument nie jest fakturą zaliczkową
ErrorCode 3 – dokument posiada korektę w buforze
ErrorCode 4 – dokument jest anulowany
ErrorCode 5 – dokument jest w buforze
ErrorCode 6 – dokument jest korektą faktury zaliczkowej
ErrorCode 7 – dokument już został przekształcony do finalnej
ErrorCode 8 – dokument nie jest możliwy do przekształcenia (wystawiony przed 2019 rokiem)
ErrorCode 9 – dokument jest fakturą finalną

Przykładowa odpowiedź JSON:

{
    "Message": "Tego dokumentu nie można przekształcić do faktury finalnej.",
    "Code": "DocumentException",
    "Data": {
        "ErrorCode": "5"
    }
}