Chilkat Online Tools

PureBasic / Egyptian eInvoicing SDK R1.5 / 6. Get Receipt Submission

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    queryParams.i = CkJsonObject::ckCreate()
    If queryParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(queryParams,"DocumentId","a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0")
    CkJsonObject::ckUpdateString(queryParams,"ReceiptNumber","1234566788")
    CkJsonObject::ckUpdateString(queryParams,"DocumentTypeCode","R")
    CkJsonObject::ckUpdateString(queryParams,"DocumentTypeName","Return Receipt")
    CkJsonObject::ckUpdateString(queryParams,"DocumentTypeVersionNumber","1.1")
    CkJsonObject::ckUpdateInt(queryParams,"ReceiverId",113317713)
    CkJsonObject::ckUpdateString(queryParams,"ReceiverName","Taxpayer1")
    CkJsonObject::ckUpdateString(queryParams,"Status","Valid")
    CkJsonObject::ckUpdateString(queryParams,"SortBy","DateTimeReceived")
    CkJsonObject::ckUpdateString(queryParams,"SortDir","Asc")
    CkJsonObject::ckUpdateInt(queryParams,"PageNo",1)
    CkJsonObject::ckUpdateInt(queryParams,"PageSize",10)

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/api/v1/receiptsubmissions/:submissionUuid/details",queryParams)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(queryParams)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "DocumentId=a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0"
	-d "ReceiptNumber=1234566788"
	-d "DocumentTypeCode=R"
	-d "DocumentTypeName=Return%20Receipt"
	-d "DocumentTypeVersionNumber=1.1"
	-d "ReceiverId=113317713"
	-d "ReceiverName=Taxpayer1"
	-d "Status=Valid"
	-d "SortBy=DateTimeReceived"
	-d "SortDir=Asc"
	-d "PageNo=1"
	-d "PageSize=10"
	-H "Authorization: Bearer <access_token>"
https://domain.com/api/v1/receiptsubmissions/:submissionUuid/details

Postman Collection Item JSON

{
  "name": "6. Get Receipt Submission",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{generatedAccessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{apiBaseUrl}}/api/v1/receiptsubmissions/:submissionUuid/details?DocumentId=a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0&ReceiptNumber=1234566788&DocumentTypeCode=R&DocumentTypeName=Return Receipt&DocumentTypeVersionNumber=1.1&ReceiverId=113317713&ReceiverName=Taxpayer1&Status=Valid&SortBy=DateTimeReceived&SortDir=Asc&PageNo=1&PageSize=10",
      "host": [
        "{{apiBaseUrl}}"
      ],
      "path": [
        "api",
        "v1",
        "receiptsubmissions",
        ":submissionUuid",
        "details"
      ],
      "query": [
        {
          "key": "DocumentId",
          "value": "a9d6831c554702f36fd782964ad1b4738f83ea2705eafe28d48d2cf64b331af0"
        },
        {
          "key": "ReceiptNumber",
          "value": "1234566788"
        },
        {
          "key": "DocumentTypeCode",
          "value": "R"
        },
        {
          "key": "DocumentTypeName",
          "value": "Return Receipt"
        },
        {
          "key": "DocumentTypeVersionNumber",
          "value": "1.1"
        },
        {
          "key": "ReceiverId",
          "value": "113317713"
        },
        {
          "key": "ReceiverName",
          "value": "Taxpayer1"
        },
        {
          "key": "Status",
          "value": "Valid"
        },
        {
          "key": "SortBy",
          "value": "DateTimeReceived"
        },
        {
          "key": "SortDir",
          "value": "Asc"
        },
        {
          "key": "PageNo",
          "value": "1"
        },
        {
          "key": "PageSize",
          "value": "10"
        }
      ],
      "variable": [
        {
          "key": "submissionUuid",
          "value": "RAQTYQ327VC4Q9170KJYMG5G10",
          "description": "(Required) "
        }
      ]
    }
  },
  "response": [
  ]
}