Firmbox

Click here for a complete list of operations.

getTransferDocument

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: "getTransferDocument"

<?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>
    <documentType xmlns="http://tempuri.org/">EInvoice or EArchive or EDespatchIn or EDespatchOut or ECreditNote or ESelfEmployedReceipt or Envelope or IncorrectDetails or Response or EArchiveReport or ReceiptAdviceIn or ReceiptAdviceOut</documentType>
    <itemPosition xmlns="http://tempuri.org/">Submitted or Incoming</itemPosition>
    <id xmlns="http://tempuri.org/">string</id>
    <isHtml xmlns="http://tempuri.org/">boolean</isHtml>
  </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>
    <getTransferDocumentResult xmlns="http://tempuri.org/">
      <id>string</id>
      <binaryData>base64Binary</binaryData>
      <hash>string</hash>
      <ownerDigest>string</ownerDigest>
      <status>
        <Code>string</Code>
        <Description>string</Description>
      </status>
    </getTransferDocumentResult>
  </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>
    <documentType xmlns="http://tempuri.org/">EInvoice or EArchive or EDespatchIn or EDespatchOut or ECreditNote or ESelfEmployedReceipt or Envelope or IncorrectDetails or Response or EArchiveReport or ReceiptAdviceIn or ReceiptAdviceOut</documentType>
    <itemPosition xmlns="http://tempuri.org/">Submitted or Incoming</itemPosition>
    <id xmlns="http://tempuri.org/">string</id>
    <isHtml xmlns="http://tempuri.org/">boolean</isHtml>
  </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>
    <getTransferDocumentResult xmlns="http://tempuri.org/">
      <id>string</id>
      <binaryData>base64Binary</binaryData>
      <hash>string</hash>
      <ownerDigest>string</ownerDigest>
      <status>
        <Code>string</Code>
        <Description>string</Description>
      </status>
    </getTransferDocumentResult>
  </soap12:Body>
</soap12:Envelope>