Skip to main content

Declarations

General​

Web service type: Command & Query Web Services

Resource location: /webservices/declarations.asmx?wsdl

General data contracts​

public class DeclarationSummary
{
    public int Id;                               // Unique Id of the return.
    public string DocumentCode;                  // Code of the return. One of the fixed values: VATTURNOVER, VATICT, YEARLYSUPPLETION, TAXGROUP or TXGRPYRSP.
    public string Name;                          // Name of the return.
    public DocumentTimeFrame DocumentTimeFrame;  // Period of the return.
    public DocumentStatus Status;                // Status of the return.
    public CodeName Assignee;                    // Name of the assignee of the return.
    public CodeName Company;                     // Name of the office.
}

public class DocumentTimeFrame
{
    public string Period;  // Period part of the year/period.
}

public class DocumentStatus
{
    public string Description;       // Description of the status.
    public int StepIndex;            // Status number:
                                     // 1 = Created
                                     // 2 = Modified
                                     // 3 = Sending
                                     // 4 = Error while sending
                                     // 5 = Sent
                                     // 6 = Rejected
                                     // 7 = Approved
                                     // 8 = Authorized
    public string ExtraInformation;  // Optional extra information about the status.
}

public class CodeName
{
    public string Code;  // Code.
    public string Name;  // Name.
}
public class MessageOfLoadMessage
{
    public MessageType TypeField;
    public string TextField;
    public LoadMessage CodeField;
    public string ParametersField;
}

public class MessageOfSetStatusMessages
{
    public MessageType TypeField;
    public string TextField;
    public SetStatusMessages CodeField;
    public string ParametersField;
}

public enum MessageType
{
    Error,
    Warning,
    Informational
}

public enum LoadMessage
{
    NoAccess,
    InvalidCode,
    InvalidParameter,
    NotSupported,
    InvalidDocumentType
}

public enum SetStatusMessages
{
    NoAccess,
    DocumentDoesNotExist,
    StartStatusInCorrectForTransition,
    UnableToPerformTransition
}

Commands​

SetToSent​

public class SetToSent : MessageOfSetStatusMessages
{
    public int documentId;  // Id of the document to be changed. Mandatory.
}

SetToApproved​

public class SetToApproved : MessageOfSetStatusMessages
{
    public int documentId;  // Id of the document to be changed. Mandatory.
}

SetToRejected​

public class SetToRejected : MessageOfSetStatusMessages
{
    public int DocumentId;  // Id of the document to be changed. Mandatory.
    public string Reason;   // The reason why the document is set to rejected. Mandatory.
}

Queries​

GetAllSummaries​

public class GetAllSummaries : MessageOfLoadMessage
{
    public string CompanyCode;            // The code of the office for which the returns should be retrieved. Mandatory.
    public DeclarationSummary VatReturn;  // List of returns.
}

GetRangeOfSummaries​

public class GetRangeOfSummaries : MessageOfLoadMessage
{
    public string CompanyCode;            // The code of the office for which the returns should be retrieved. Mandatory.
    public int StartIndex;                // The index of the first record to be retrieved. Mandatory.
    public int Count;                     // The number of records to be retrieved. Mandatory.
    public DeclarationSummary VatReturn;  // List of returns.
}

GetNumberOfDeclarations​

public class GetNumberOfDeclarations : MessageOfLoadMessage
{
    public string CompanyCode;           // The code of the office for which the returns should be retrieved. Mandatory.
    public int NumberOfVatReturns;       // The number of returns.
}

GetVatReturnAsXbrl​

public class GetVatReturnAsXbrl : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public bool IsMessageIdRequired;     // If set to True the MessageReferenceSupplierVAT element will be filled in. If set to False it will be left empty. Mandatory.
    public XmlNode VatReturn;            // The VAT return in XBRL format.
}

GetVatReturnAsXml​

public class GetVatReturnAsXml : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public XmlNode VatReturn;            // The VAT return in XML format.
}

GetVatReturnPaymentReference​

public class GetVatReturnPaymentReference : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public string PaymentReference;      // The payment reference.
}

GetIctReturnAsXbrl​

public class GetIctReturnAsXbrl : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public bool IsMessageIdRequired;     // If set to True the MessageReferenceSupplierICT element will be filled in. If set to False it will be left empty. Mandatory.
    public XmlNode VatReturn;            // The ICT return in XBRL format.
}

GetIctReturnAsXml​

public class GetIctReturnAsXml : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public XmlNode VatReturn;            // The ICT return in XML format.
}

GetTaxGroupVatReturnAsXbrl​

public class GetTaxGroupVatReturnAsXbrl : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public bool IsMessageIdRequired;     // If set to True the MessageReferenceSupplierVAT element will be filled in. If set to False it will be left empty. Mandatory.
    public XmlNode VatReturn;            // The VAT return in XBRL format.
}

GetTaxGroupVatReturnAsXml​

public class GetTaxGroupVatReturnAsXml : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public XmlNode VatReturn;            // The VAT return in XML format.
}

GetTaxGroupVatReturnPaymentReference​

public class GetTaxGroupVatReturnPaymentReference : MessageOfLoadMessage
{
    public int DocumentId;               // Id of the document to be retrieved. Mandatory.
    public string PaymentReference;      // The payment reference.
}