Firmbox

Click here for a complete list of operations.

getPackageCurrentStatus

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /EFatura/Firmbox/Firmbox.asmx HTTP/1.1
Host: firma.myefatura.com.tr
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "getPackageCurrentStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <sessionId xmlns="http://tempuri.org/">string</sessionId>
    <itemPosition xmlns="http://tempuri.org/">Submitted or Incoming</itemPosition>
    <contentType xmlns="http://tempuri.org/">EInvoice or EArchive or EDespatch or ECreditNote or ESelfEmployedReceipt or zReport or eTicket or ePassengerList or NonTaxPayer</contentType>
    <queueUUID xmlns="http://tempuri.org/">string</queueUUID>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getPackageCurrentStatusResult xmlns="http://tempuri.org/">
      <PackageStatus>
        <Code>string</Code>
        <Description>string</Description>
      </PackageStatus>
      <DocumentStatus>
        <DocumentCurrentStatusDataInfo>
          <UUID>string</UUID>
          <ID>string</ID>
          <IssueDate>dateTime</IssueDate>
          <TransactionType>int</TransactionType>
          <TransactionSerial>string</TransactionSerial>
          <TransactionNumber>int</TransactionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <EnvelopeId>string</EnvelopeId>
          <EnvelopeStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeStatus>
          <EnvelopeCenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeCenterStatus>
          <TokenUri>string</TokenUri>
        </DocumentCurrentStatusDataInfo>
        <DocumentCurrentStatusDataInfo>
          <UUID>string</UUID>
          <ID>string</ID>
          <IssueDate>dateTime</IssueDate>
          <TransactionType>int</TransactionType>
          <TransactionSerial>string</TransactionSerial>
          <TransactionNumber>int</TransactionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <EnvelopeId>string</EnvelopeId>
          <EnvelopeStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeStatus>
          <EnvelopeCenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeCenterStatus>
          <TokenUri>string</TokenUri>
        </DocumentCurrentStatusDataInfo>
      </DocumentStatus>
    </getPackageCurrentStatusResult>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /EFatura/Firmbox/Firmbox.asmx HTTP/1.1
Host: firma.myefatura.com.tr
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <sessionId xmlns="http://tempuri.org/">string</sessionId>
    <itemPosition xmlns="http://tempuri.org/">Submitted or Incoming</itemPosition>
    <contentType xmlns="http://tempuri.org/">EInvoice or EArchive or EDespatch or ECreditNote or ESelfEmployedReceipt or zReport or eTicket or ePassengerList or NonTaxPayer</contentType>
    <queueUUID xmlns="http://tempuri.org/">string</queueUUID>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getPackageCurrentStatusResult xmlns="http://tempuri.org/">
      <PackageStatus>
        <Code>string</Code>
        <Description>string</Description>
      </PackageStatus>
      <DocumentStatus>
        <DocumentCurrentStatusDataInfo>
          <UUID>string</UUID>
          <ID>string</ID>
          <IssueDate>dateTime</IssueDate>
          <TransactionType>int</TransactionType>
          <TransactionSerial>string</TransactionSerial>
          <TransactionNumber>int</TransactionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <EnvelopeId>string</EnvelopeId>
          <EnvelopeStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeStatus>
          <EnvelopeCenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeCenterStatus>
          <TokenUri>string</TokenUri>
        </DocumentCurrentStatusDataInfo>
        <DocumentCurrentStatusDataInfo>
          <UUID>string</UUID>
          <ID>string</ID>
          <IssueDate>dateTime</IssueDate>
          <TransactionType>int</TransactionType>
          <TransactionSerial>string</TransactionSerial>
          <TransactionNumber>int</TransactionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <EnvelopeId>string</EnvelopeId>
          <EnvelopeStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeStatus>
          <EnvelopeCenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </EnvelopeCenterStatus>
          <TokenUri>string</TokenUri>
        </DocumentCurrentStatusDataInfo>
      </DocumentStatus>
    </getPackageCurrentStatusResult>
  </soap12:Body>
</soap12:Envelope>