Firmbox Web Service

Firmbox

Click here for a complete list of operations.

getInvoiceFromId

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

<?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>
    <ids xmlns="http://tempuri.org/">
      <string>string</string>
      <string>string</string>
    </ids>
  </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>
    <getInvoiceFromIdResult xmlns="http://tempuri.org/">
      <InvoiceDataInfo>
        <Id>string</Id>
        <InvoiceType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</InvoiceType>
        <GIBSerial>string</GIBSerial>
        <GIBSerialId>int</GIBSerialId>
        <DocumentHeader>
          <TransactionUserId>string</TransactionUserId>
          <TransactionDate>dateTime</TransactionDate>
          <DocumentDate>dateTime</DocumentDate>
          <CreatedDate>dateTime</CreatedDate>
          <DespatchDate>dateTime</DespatchDate>
        </DocumentHeader>
        <SignatoryId>string</SignatoryId>
        <UserTaxIdentification>string</UserTaxIdentification>
        <UserTitle>string</UserTitle>
        <UserAlias>string</UserAlias>
        <Summary>
          <LineCount>int</LineCount>
          <LineExtensionAmount>double</LineExtensionAmount>
          <TaxExclusiveAmount>double</TaxExclusiveAmount>
          <TaxInclusiveAmount>double</TaxInclusiveAmount>
          <AllowanceTotalAmount>double</AllowanceTotalAmount>
          <ChargeTotalAmount>double</ChargeTotalAmount>
          <PayableRoundingAmount>double</PayableRoundingAmount>
          <PayableAmount>double</PayableAmount>
        </Summary>
        <Status>
          <Code>string</Code>
          <Description>string</Description>
        </Status>
        <EnvelopeId>string</EnvelopeId>
        <EnvelopeCreateDate>dateTime</EnvelopeCreateDate>
        <EnvelopeDate>dateTime</EnvelopeDate>
        <EnvelopeStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeStatus>
        <EnvelopeCenterStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeCenterStatus>
        <InvoiceTypeCode>string</InvoiceTypeCode>
        <InvoiceCurrencyCode>string</InvoiceCurrencyCode>
        <Credit>double</Credit>
        <Responses>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
        </Responses>
        <CustomDetails>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
        </CustomDetails>
        <EArchiveDetail>
          <Id>string</Id>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <SectionFirstDate>dateTime</SectionFirstDate>
          <SectionLastDate>dateTime</SectionLastDate>
          <SectionNumber>int</SectionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <CenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </CenterStatus>
          <CancelationReason>string</CancelationReason>
          <CancelationDate>dateTime</CancelationDate>
          <ObjectionReason>string</ObjectionReason>
          <ObjectionDate>dateTime</ObjectionDate>
          <ObjectionMethod>string</ObjectionMethod>
          <ObjectionId>string</ObjectionId>
        </EArchiveDetail>
        <TokenUri>string</TokenUri>
        <Tags>
          <string>string</string>
          <string>string</string>
        </Tags>
        <CancelationReason>string</CancelationReason>
        <CancelationDate>dateTime</CancelationDate>
        <CreatedDate>dateTime</CreatedDate>
      </InvoiceDataInfo>
      <InvoiceDataInfo>
        <Id>string</Id>
        <InvoiceType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</InvoiceType>
        <GIBSerial>string</GIBSerial>
        <GIBSerialId>int</GIBSerialId>
        <DocumentHeader>
          <TransactionUserId>string</TransactionUserId>
          <TransactionDate>dateTime</TransactionDate>
          <DocumentDate>dateTime</DocumentDate>
          <CreatedDate>dateTime</CreatedDate>
          <DespatchDate>dateTime</DespatchDate>
        </DocumentHeader>
        <SignatoryId>string</SignatoryId>
        <UserTaxIdentification>string</UserTaxIdentification>
        <UserTitle>string</UserTitle>
        <UserAlias>string</UserAlias>
        <Summary>
          <LineCount>int</LineCount>
          <LineExtensionAmount>double</LineExtensionAmount>
          <TaxExclusiveAmount>double</TaxExclusiveAmount>
          <TaxInclusiveAmount>double</TaxInclusiveAmount>
          <AllowanceTotalAmount>double</AllowanceTotalAmount>
          <ChargeTotalAmount>double</ChargeTotalAmount>
          <PayableRoundingAmount>double</PayableRoundingAmount>
          <PayableAmount>double</PayableAmount>
        </Summary>
        <Status>
          <Code>string</Code>
          <Description>string</Description>
        </Status>
        <EnvelopeId>string</EnvelopeId>
        <EnvelopeCreateDate>dateTime</EnvelopeCreateDate>
        <EnvelopeDate>dateTime</EnvelopeDate>
        <EnvelopeStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeStatus>
        <EnvelopeCenterStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeCenterStatus>
        <InvoiceTypeCode>string</InvoiceTypeCode>
        <InvoiceCurrencyCode>string</InvoiceCurrencyCode>
        <Credit>double</Credit>
        <Responses>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
        </Responses>
        <CustomDetails>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
        </CustomDetails>
        <EArchiveDetail>
          <Id>string</Id>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <SectionFirstDate>dateTime</SectionFirstDate>
          <SectionLastDate>dateTime</SectionLastDate>
          <SectionNumber>int</SectionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <CenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </CenterStatus>
          <CancelationReason>string</CancelationReason>
          <CancelationDate>dateTime</CancelationDate>
          <ObjectionReason>string</ObjectionReason>
          <ObjectionDate>dateTime</ObjectionDate>
          <ObjectionMethod>string</ObjectionMethod>
          <ObjectionId>string</ObjectionId>
        </EArchiveDetail>
        <TokenUri>string</TokenUri>
        <Tags>
          <string>string</string>
          <string>string</string>
        </Tags>
        <CancelationReason>string</CancelationReason>
        <CancelationDate>dateTime</CancelationDate>
        <CreatedDate>dateTime</CreatedDate>
      </InvoiceDataInfo>
    </getInvoiceFromIdResult>
  </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>
    <ids xmlns="http://tempuri.org/">
      <string>string</string>
      <string>string</string>
    </ids>
  </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>
    <getInvoiceFromIdResult xmlns="http://tempuri.org/">
      <InvoiceDataInfo>
        <Id>string</Id>
        <InvoiceType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</InvoiceType>
        <GIBSerial>string</GIBSerial>
        <GIBSerialId>int</GIBSerialId>
        <DocumentHeader>
          <TransactionUserId>string</TransactionUserId>
          <TransactionDate>dateTime</TransactionDate>
          <DocumentDate>dateTime</DocumentDate>
          <CreatedDate>dateTime</CreatedDate>
          <DespatchDate>dateTime</DespatchDate>
        </DocumentHeader>
        <SignatoryId>string</SignatoryId>
        <UserTaxIdentification>string</UserTaxIdentification>
        <UserTitle>string</UserTitle>
        <UserAlias>string</UserAlias>
        <Summary>
          <LineCount>int</LineCount>
          <LineExtensionAmount>double</LineExtensionAmount>
          <TaxExclusiveAmount>double</TaxExclusiveAmount>
          <TaxInclusiveAmount>double</TaxInclusiveAmount>
          <AllowanceTotalAmount>double</AllowanceTotalAmount>
          <ChargeTotalAmount>double</ChargeTotalAmount>
          <PayableRoundingAmount>double</PayableRoundingAmount>
          <PayableAmount>double</PayableAmount>
        </Summary>
        <Status>
          <Code>string</Code>
          <Description>string</Description>
        </Status>
        <EnvelopeId>string</EnvelopeId>
        <EnvelopeCreateDate>dateTime</EnvelopeCreateDate>
        <EnvelopeDate>dateTime</EnvelopeDate>
        <EnvelopeStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeStatus>
        <EnvelopeCenterStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeCenterStatus>
        <InvoiceTypeCode>string</InvoiceTypeCode>
        <InvoiceCurrencyCode>string</InvoiceCurrencyCode>
        <Credit>double</Credit>
        <Responses>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
        </Responses>
        <CustomDetails>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
        </CustomDetails>
        <EArchiveDetail>
          <Id>string</Id>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <SectionFirstDate>dateTime</SectionFirstDate>
          <SectionLastDate>dateTime</SectionLastDate>
          <SectionNumber>int</SectionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <CenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </CenterStatus>
          <CancelationReason>string</CancelationReason>
          <CancelationDate>dateTime</CancelationDate>
          <ObjectionReason>string</ObjectionReason>
          <ObjectionDate>dateTime</ObjectionDate>
          <ObjectionMethod>string</ObjectionMethod>
          <ObjectionId>string</ObjectionId>
        </EArchiveDetail>
        <TokenUri>string</TokenUri>
        <Tags>
          <string>string</string>
          <string>string</string>
        </Tags>
        <CancelationReason>string</CancelationReason>
        <CancelationDate>dateTime</CancelationDate>
        <CreatedDate>dateTime</CreatedDate>
      </InvoiceDataInfo>
      <InvoiceDataInfo>
        <Id>string</Id>
        <InvoiceType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</InvoiceType>
        <GIBSerial>string</GIBSerial>
        <GIBSerialId>int</GIBSerialId>
        <DocumentHeader>
          <TransactionUserId>string</TransactionUserId>
          <TransactionDate>dateTime</TransactionDate>
          <DocumentDate>dateTime</DocumentDate>
          <CreatedDate>dateTime</CreatedDate>
          <DespatchDate>dateTime</DespatchDate>
        </DocumentHeader>
        <SignatoryId>string</SignatoryId>
        <UserTaxIdentification>string</UserTaxIdentification>
        <UserTitle>string</UserTitle>
        <UserAlias>string</UserAlias>
        <Summary>
          <LineCount>int</LineCount>
          <LineExtensionAmount>double</LineExtensionAmount>
          <TaxExclusiveAmount>double</TaxExclusiveAmount>
          <TaxInclusiveAmount>double</TaxInclusiveAmount>
          <AllowanceTotalAmount>double</AllowanceTotalAmount>
          <ChargeTotalAmount>double</ChargeTotalAmount>
          <PayableRoundingAmount>double</PayableRoundingAmount>
          <PayableAmount>double</PayableAmount>
        </Summary>
        <Status>
          <Code>string</Code>
          <Description>string</Description>
        </Status>
        <EnvelopeId>string</EnvelopeId>
        <EnvelopeCreateDate>dateTime</EnvelopeCreateDate>
        <EnvelopeDate>dateTime</EnvelopeDate>
        <EnvelopeStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeStatus>
        <EnvelopeCenterStatus>
          <Code>string</Code>
          <Description>string</Description>
        </EnvelopeCenterStatus>
        <InvoiceTypeCode>string</InvoiceTypeCode>
        <InvoiceCurrencyCode>string</InvoiceCurrencyCode>
        <Credit>double</Credit>
        <Responses>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
          <ResponseDataInfo>
            <Id>string</Id>
            <Date>dateTime</Date>
            <Code>string</Code>
            <Description>string</Description>
            <IsApplicationResponse>boolean</IsApplicationResponse>
            <CenterStatus xsi:nil="true" />
            <EnvelopeId>string</EnvelopeId>
          </ResponseDataInfo>
        </Responses>
        <CustomDetails>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
          <InvoiceDetailDataInfo>
            <ItemType>CustomAdditionalDocumentReference or SupplierPartyIdentification or SupplierAgentPartyPartyIdentification or CustomerPartyIdentification or CustomerAgentPartyPartyIdentification</ItemType>
            <ItemIndex>int</ItemIndex>
            <ItemDataType>idtString or idtDateTime or idtDateDouble</ItemDataType>
            <ItemName>string</ItemName>
            <ItemValue>string</ItemValue>
            <AttributeName>string</AttributeName>
            <AttributeValue>string</AttributeValue>
          </InvoiceDetailDataInfo>
        </CustomDetails>
        <EArchiveDetail>
          <Id>string</Id>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <SectionFirstDate>dateTime</SectionFirstDate>
          <SectionLastDate>dateTime</SectionLastDate>
          <SectionNumber>int</SectionNumber>
          <Status>
            <Code>string</Code>
            <Description>string</Description>
          </Status>
          <CenterStatus>
            <Code>string</Code>
            <Description>string</Description>
          </CenterStatus>
          <CancelationReason>string</CancelationReason>
          <CancelationDate>dateTime</CancelationDate>
          <ObjectionReason>string</ObjectionReason>
          <ObjectionDate>dateTime</ObjectionDate>
          <ObjectionMethod>string</ObjectionMethod>
          <ObjectionId>string</ObjectionId>
        </EArchiveDetail>
        <TokenUri>string</TokenUri>
        <Tags>
          <string>string</string>
          <string>string</string>
        </Tags>
        <CancelationReason>string</CancelationReason>
        <CancelationDate>dateTime</CancelationDate>
        <CreatedDate>dateTime</CreatedDate>
      </InvoiceDataInfo>
    </getInvoiceFromIdResult>
  </soap12:Body>
</soap12:Envelope>