Chilkat Online Tools

Ruby / KSeF / Pobranie listy faktur dla identyfikatora płatności

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.SetRequestHeader("Accept","application/json")
http.SetRequestHeader("SessionToken","{{apiKey}}")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://ksef.mf.gov.pl/api/online/Payment/Identifier/GetReferenceNumbers/:PaymentIdentifier",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "ksefReferenceNumberList": [
#     "<string>"
#   ],
#   "referenceNumber": "50781001-OV-58CE1FE5C8-F954BCECCD-AC",
#   "timestamp": "<dateTime>"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

referenceNumber = jResp.stringOf("referenceNumber")
timestamp = jResp.stringOf("timestamp")
i = 0
count_i = jResp.SizeOfArray("ksefReferenceNumberList")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("ksefReferenceNumberList[i]")
    i = i + 1
end

Curl Command

curl -X GET
	-H "SessionToken: {{apiKey}}"
	-H "Accept: application/json"
https://ksef.mf.gov.pl/api/online/Payment/Identifier/GetReferenceNumbers/:PaymentIdentifier

Postman Collection Item JSON

{
  "name": "Pobranie listy faktur dla identyfikatora płatności",
  "request": {
    "auth": {
      "type": "apikey",
      "apikey": [
        {
          "key": "key",
          "value": "SessionToken",
          "type": "string"
        },
        {
          "key": "value",
          "value": "{{apiKey}}",
          "type": "string"
        },
        {
          "key": "in",
          "value": "header",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/online/Payment/Identifier/GetReferenceNumbers/:PaymentIdentifier",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "online",
        "Payment",
        "Identifier",
        "GetReferenceNumbers",
        ":PaymentIdentifier"
      ],
      "variable": [
        {
          "key": "PaymentIdentifier",
          "value": "<string>"
        }
      ]
    },
    "description": "Pobranie listy faktur dla identyfikatora płatności"
  },
  "response": [
    {
      "name": "Pobrano faktury oznaczone identyfikatorem płatności",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Payment/Identifier/GetReferenceNumbers/:PaymentIdentifier",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Payment",
            "Identifier",
            "GetReferenceNumbers",
            ":PaymentIdentifier"
          ],
          "variable": [
            {
              "key": "PaymentIdentifier"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ksefReferenceNumberList\": [\n    \"<string>\"\n  ],\n  \"referenceNumber\": \"50781001-OV-58CE1FE5C8-F954BCECCD-AC\",\n  \"timestamp\": \"<dateTime>\"\n}"
    },
    {
      "name": "Nieprawidłowe wywołanie",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Payment/Identifier/GetReferenceNumbers/:PaymentIdentifier",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Payment",
            "Identifier",
            "GetReferenceNumbers",
            ":PaymentIdentifier"
          ],
          "variable": [
            {
              "key": "PaymentIdentifier"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"exception\": {\n    \"exceptionDetailList\": [\n      {\n        \"exceptionCode\": \"<integer>\",\n        \"exceptionDescription\": \"<string>\"\n      }\n    ],\n    \"serviceCode\": \"<string>\",\n    \"serviceCtx\": \"<string>\",\n    \"serviceName\": \"<string>\",\n    \"timestamp\": \"<dateTime>\",\n    \"referenceNumber\": \"20560508-TX-BC1107E227-31DE9417C0-CE\"\n  }\n}"
    },
    {
      "name": "Nieautoryzowany dostęp",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Payment/Identifier/GetReferenceNumbers/:PaymentIdentifier",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Payment",
            "Identifier",
            "GetReferenceNumbers",
            ":PaymentIdentifier"
          ],
          "variable": [
            {
              "key": "PaymentIdentifier"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"exception\": {\n    \"exceptionDetailList\": [\n      {\n        \"exceptionCode\": \"<integer>\",\n        \"exceptionDescription\": \"<string>\"\n      }\n    ],\n    \"serviceCode\": \"<string>\",\n    \"serviceCtx\": \"<string>\",\n    \"serviceName\": \"<string>\",\n    \"timestamp\": \"<dateTime>\",\n    \"referenceNumber\": \"20560508-TX-BC1107E227-31DE9417C0-CE\"\n  }\n}"
    },
    {
      "name": "Nie znaleziono wyszukiwanej treści",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Payment/Identifier/GetReferenceNumbers/:PaymentIdentifier",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Payment",
            "Identifier",
            "GetReferenceNumbers",
            ":PaymentIdentifier"
          ],
          "variable": [
            {
              "key": "PaymentIdentifier"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}