Activation Get

Retrieve the current tax communication activation status for your account.

Operation

TaxCommunicationActivationGet

Request

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:mag="http://magnifinance.com/api/v2.1"
  xmlns:auth="http://magnifinance.com/auth">
  <soapenv:Header>
    <auth:Credentials>
      <auth:ClientId>your_client_id</auth:ClientId>
      <auth:ClientSecret>your_client_secret</auth:ClientSecret>
    </auth:Credentials>
  </soapenv:Header>
  <soapenv:Body>
    <mag:TaxCommunicationActivationGet />
  </soapenv:Body>
</soapenv:Envelope>

Parameters

This operation does not require any parameters. It retrieves the activation status for the authenticated account.

Response

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <mag:TaxCommunicationActivationGetResponse xmlns:mag="http://magnifinance.com/api/v2.1">
      <mag:Result>
        <mag:Success>true</mag:Success>
        <mag:ActivationStatus>
          <mag:Enabled>true</mag:Enabled>
          <mag:ActivatedAt>2024-01-15T10:30:00Z</mag:ActivatedAt>
          <mag:ATUsername>your_at_username</mag:ATUsername>
          <mag:AutoCommunicate>true</mag:AutoCommunicate>
          <mag:LastCommunicationAt>2024-01-20T14:25:00Z</mag:LastCommunicationAt>
          <mag:TotalDocumentsCommunicated>150</mag:TotalDocumentsCommunicated>
        </mag:ActivationStatus>
      </mag:Result>
    </mag:TaxCommunicationActivationGetResponse>
  </soapenv:Body>
</soapenv:Envelope>

Response Fields

Field	Type	Description
Enabled	boolean	Whether tax communication is currently enabled
ActivatedAt	datetime	When tax communication was activated
ATUsername	string	The AT username configured for this account
AutoCommunicate	boolean	Whether documents are automatically communicated
LastCommunicationAt	datetime	Timestamp of the last successful communication
TotalDocumentsCommunicated	integer	Total number of documents communicated to AT

Response (Not Activated)

If tax communication has not been activated, the response will indicate this:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <mag:TaxCommunicationActivationGetResponse xmlns:mag="http://magnifinance.com/api/v2.1">
      <mag:Result>
        <mag:Success>true</mag:Success>
        <mag:ActivationStatus>
          <mag:Enabled>false</mag:Enabled>
          <mag:Message>Tax communication has not been activated for this account</mag:Message>
        </mag:ActivationStatus>
      </mag:Result>
    </mag:TaxCommunicationActivationGetResponse>
  </soapenv:Body>
</soapenv:Envelope>

Example (C#)

using System.ServiceModel;

var binding = new BasicHttpsBinding();
var endpoint = new EndpointAddress("https://api.magnifinance.com/soap/v2.1/TaxCommunication");
var client = new TaxCommunicationClient(binding, endpoint);

var result = await client.TaxCommunicationActivationGetAsync(credentials);

if (result.Success)
{
    var status = result.ActivationStatus;

    Console.WriteLine($"Enabled: {status.Enabled}");
    Console.WriteLine($"Activated At: {status.ActivatedAt}");
    Console.WriteLine($"Auto Communicate: {status.AutoCommunicate}");
    Console.WriteLine($"Total Documents: {status.TotalDocumentsCommunicated}");
}

Use Cases

• Health check: Verify that tax communication is properly configured before issuing documents
• Dashboard display: Show activation status in your application's dashboard
• Troubleshooting: Diagnose communication issues by checking the last communication timestamp