Firmbox
Click here for a complete list of operations.
getDespatchAdviceFromId
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: "getDespatchAdviceFromId" <?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> <getDespatchAdviceFromIdResult xmlns="http://tempuri.org/"> <DespatchAdviceDataInfo> <Id>string</Id> <DespatchType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</DespatchType> <DespatchTypeCode>string</DespatchTypeCode> <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> <DespatchCurrencyCode>string</DespatchCurrencyCode> <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> <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> <Credit>double</Credit> <ResponseExistReceivedQuantity>boolean</ResponseExistReceivedQuantity> <ResponseExistShortQuantity>boolean</ResponseExistShortQuantity> <ResponseExistRejectedQuantity>boolean</ResponseExistRejectedQuantity> <ResponseExistOversupplyQuantity>boolean</ResponseExistOversupplyQuantity> <ResponseExistTimingComplaint>boolean</ResponseExistTimingComplaint> <Status> <Code>string</Code> <Description>string</Description> </Status> <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> </DespatchAdviceDataInfo> <DespatchAdviceDataInfo> <Id>string</Id> <DespatchType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</DespatchType> <DespatchTypeCode>string</DespatchTypeCode> <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> <DespatchCurrencyCode>string</DespatchCurrencyCode> <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> <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> <Credit>double</Credit> <ResponseExistReceivedQuantity>boolean</ResponseExistReceivedQuantity> <ResponseExistShortQuantity>boolean</ResponseExistShortQuantity> <ResponseExistRejectedQuantity>boolean</ResponseExistRejectedQuantity> <ResponseExistOversupplyQuantity>boolean</ResponseExistOversupplyQuantity> <ResponseExistTimingComplaint>boolean</ResponseExistTimingComplaint> <Status> <Code>string</Code> <Description>string</Description> </Status> <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> </DespatchAdviceDataInfo> </getDespatchAdviceFromIdResult> </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> <getDespatchAdviceFromIdResult xmlns="http://tempuri.org/"> <DespatchAdviceDataInfo> <Id>string</Id> <DespatchType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</DespatchType> <DespatchTypeCode>string</DespatchTypeCode> <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> <DespatchCurrencyCode>string</DespatchCurrencyCode> <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> <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> <Credit>double</Credit> <ResponseExistReceivedQuantity>boolean</ResponseExistReceivedQuantity> <ResponseExistShortQuantity>boolean</ResponseExistShortQuantity> <ResponseExistRejectedQuantity>boolean</ResponseExistRejectedQuantity> <ResponseExistOversupplyQuantity>boolean</ResponseExistOversupplyQuantity> <ResponseExistTimingComplaint>boolean</ResponseExistTimingComplaint> <Status> <Code>string</Code> <Description>string</Description> </Status> <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> </DespatchAdviceDataInfo> <DespatchAdviceDataInfo> <Id>string</Id> <DespatchType>Basic or Trading or Passenger or Export or EArchive or EPublic or MarketplaceRegistrationSystem or Energy</DespatchType> <DespatchTypeCode>string</DespatchTypeCode> <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> <DespatchCurrencyCode>string</DespatchCurrencyCode> <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> <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> <Credit>double</Credit> <ResponseExistReceivedQuantity>boolean</ResponseExistReceivedQuantity> <ResponseExistShortQuantity>boolean</ResponseExistShortQuantity> <ResponseExistRejectedQuantity>boolean</ResponseExistRejectedQuantity> <ResponseExistOversupplyQuantity>boolean</ResponseExistOversupplyQuantity> <ResponseExistTimingComplaint>boolean</ResponseExistTimingComplaint> <Status> <Code>string</Code> <Description>string</Description> </Status> <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> </DespatchAdviceDataInfo> </getDespatchAdviceFromIdResult> </soap12:Body> </soap12:Envelope>