Function getInvoice

Description

Retrieves a complete invoice with header, line items, and VAT summary grouped by rate.

Arguments

• params :

      array (
            [ 'idInvoice' ] = string,  // Invoice ID (32 char GUID) - REQUIRED
          )
      

Example

  require_once ( 'classUddsOx.php' ) ;

  $udds = new classUddsOx ;
  $udds->customerCode = [your_customerCode] ;
  $udds->login = [your_login] ;
  $udds->password = [your_password] ;
  $udds->serverUrl = 'http://api.dlaoperatora.pl/udds/' ;
  
  $params = array();
  $params['idInvoice'] = '00000004M1G221031126JF1B44ASNQ6D';
  
  $ret = $udds->getInvoice($params);
  
  // $ret['data']['invoice'] - invoice header
  // $ret['data']['items'] - line items array
  // $ret['data']['vatSummary'] - VAT totals grouped by rate
  // $ret['data']['itemCount'] - number of line items

Returns

Success response structure

{
  "status": "OK",
  "data": {
    "invoice": {
      "idInvoice": "00000004M1G221031126JF1B44ASNQ6D",
      "invoiceNumber": "0001/02/2026",
      "issuePlace": "Warszawa",
      "issueDate": "2026-02-03",
      "saleDate": "2026-02-03",
      "paymentDueDate": "2026-02-10",
      "paymentMethod": "przelew",
      "documentType": "FV",
      "status": "AKTYWNA",
      "sellerName": "Jan Kowalski",
      
      "buyer": {
        "name": "Firma ABC Sp. z o.o.",
        "address": "ul. Przykładowa 1",
        "city": "Warszawa",
        "postCode": "00-001",
        "nip": "1234567890",
        "country": "Polska",
        ...
      },
      
      "recipient": { ... },  // If different from buyer
      
      "amounts": {
        "toPayPLN": 123000,      // 1230.00 PLN (in grosze)
        "toPayCurrency": 123000,
        "nettoPLN": 100000,
        "bruttoPLN": 123000,
        "vatPLN": 23000,
        "paid": 0
      },
      
      "currency": {
        "code": "PLN",
        "exchangeRate": 10000,   // Rate * 10000
        "calculationType": "netto"
      },
      
      "ksef": {
        "toKsef": 0,
        "ksefNumber": null,
        "processingCode": null,
        ...
      },
      
      "info": { ... },
      "system": { ... },
      "bank": { ... },
      "correction": { ... },
      "source": { ... }
    },
    
    "items": [
      {
        "idInvoiceItem": "00000004M1G221031126JF1B44ITEM01",
        "name": "Usługa programistyczna",
        "quantity": 100,           // 1.00 (×100)
        "unit": "szt.",
        "vatRate": "23",
        "priceNettoPLN": 50000,    // 500.00 PLN
        "priceBruttoPLN": 61500,
        "valueNettoPLN": 50000,
        "valueBruttoPLN": 61500,
        "valueVatPLN": 11500,
        "priceNettoCurrency": 50000,
        "priceBruttoCurrency": 61500,
        "valueNettoCurrency": 50000,
        "valueBruttoCurrency": 61500,
        "valueVatCurrency": 11500,
        ...
      },
      ...
    ],
    
    "itemCount": 5,
    
    "vatSummary": [
      {
        "vatRate": "23",
        "nettoPLN": 50000,
        "bruttoPLN": 61500,
        "vatPLN": 11500,
        "nettoCurrency": 50000,
        "bruttoCurrency": 61500,
        "vatCurrency": 11500,
        "itemCount": 1
      },
      {
        "vatRate": "8",
        "nettoPLN": 15000,
        "bruttoPLN": 16200,
        "vatPLN": 1200,
        ...
      },
      {
        "vatRate": "zw",
        "nettoPLN": 30000,
        "bruttoPLN": 30000,
        "vatPLN": 0,
        ...
      }
    ]
  },
  "errors": []
}

Error response

{
  "status": "ERROR",
  "data": null,
  "errors": [
    { "code": 1001, "message": "Parametr idInvoice jest wymagany" }
  ]
}

Error codes

Notes

• All monetary values are in grosze (×100), e.g. 12345 = 123.45 PLN
• Quantity is also ×100, e.g. 150 = 1.50 units
• Exchange rate is ×10000, e.g. 45632 = 4.5632
• VAT summary is ordered by rate descending (23%, 8%, 5%, 0%, zw, np)
• Fields with suffix "Currency" contain values in document currency (CFG_WALUTA)

Related endpoints

• getInvoiceList - List invoices
• createInvoiceHead - Create invoice header
• createInvoiceItem - Add line items
• setInvoiceStatus - Change invoice status