Package Avalara.SDK.model.EInvoicing.V1

Class Mandate

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class Mandate
extends Object
    Mandate

    • Constructor Detail

      • Mandate

        public Mandate()

    • Method Detail

      • getMandateId

        @Nullable
public String getMandateId()
        The `mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL). Keep in mind the following when specifying a `mandateId`. - A country can have multiple mandate types (B2C, B2B, B2G). - A entity/company can opt in for multiple mandates. - A `mandateId` is the combination of country + mandate type + network/regulation.
        Returns:
        mandateId

      • setMandateId

        public void setMandateId​(String mandateId)

      • countryMandate

        public Mandate countryMandate​(String countryMandate)

      • getCountryMandate

        @Nullable
public String getCountryMandate()
        **[LEGACY]** This field is retained for backward compatibility. It is recommended to use `mandateId` instead. The `countryMandate` similar to the `mandateId` is comprised of the country code, mandate type, and the network or regulation type (for example, AU-B2G-PEPPOL).
        Returns:
        countryMandate

      • setCountryMandate

        public void setCountryMandate​(String countryMandate)

      • countryCode

        public Mandate countryCode​(String countryCode)

      • getCountryCode

        @Nullable
public String getCountryCode()
        Country code
        Returns:
        countryCode

      • setCountryCode

        public void setCountryCode​(String countryCode)

      • description

        public Mandate description​(String description)

      • getDescription

        @Nullable
public String getDescription()
        Mandate description
        Returns:
        description

      • setDescription

        public void setDescription​(String description)

      • supportedByELRAPI

        public Mandate supportedByELRAPI​(Boolean supportedByELRAPI)

      • getSupportedByELRAPI

        @Nullable
public Boolean getSupportedByELRAPI()
        Indicates whether this mandate supported by the ELR API
        Returns:
        supportedByELRAPI

      • setSupportedByELRAPI

        public void setSupportedByELRAPI​(Boolean supportedByELRAPI)

      • mandateFormat

        public Mandate mandateFormat​(String mandateFormat)

      • getMandateFormat

        @Nullable
public String getMandateFormat()
        Mandate format
        Returns:
        mandateFormat

      • setMandateFormat

        public void setMandateFormat​(String mandateFormat)

      • eInvoicingFlow

        public Mandate eInvoicingFlow​(String eInvoicingFlow)

      • geteInvoicingFlow

        @Nullable
public String geteInvoicingFlow()
        The type of e-invoicing flow for this mandate
        Returns:
        eInvoicingFlow

      • seteInvoicingFlow

        public void seteInvoicingFlow​(String eInvoicingFlow)

      • eInvoicingFlowDocumentationLink

        public Mandate eInvoicingFlowDocumentationLink​(String eInvoicingFlowDocumentationLink)

      • geteInvoicingFlowDocumentationLink

        @Nullable
public String geteInvoicingFlowDocumentationLink()
        Link to the documentation for this mandate's e-invoicing flow
        Returns:
        eInvoicingFlowDocumentationLink

      • seteInvoicingFlowDocumentationLink

        public void seteInvoicingFlowDocumentationLink​(String eInvoicingFlowDocumentationLink)

      • getInvoiceAvailableMediaType

        public Mandate getInvoiceAvailableMediaType​(List<String> getInvoiceAvailableMediaType)

      • addGetInvoiceAvailableMediaTypeItem

        public Mandate addGetInvoiceAvailableMediaTypeItem​(String getInvoiceAvailableMediaTypeItem)

      • getGetInvoiceAvailableMediaType

        @Nullable
public List<String> getGetInvoiceAvailableMediaType()
        List of available media types for downloading invoices for this mandate
        Returns:
        getInvoiceAvailableMediaType

      • setGetInvoiceAvailableMediaType

        public void setGetInvoiceAvailableMediaType​(List<String> getInvoiceAvailableMediaType)

      • supportsInboundDigitalDocument

        public Mandate supportsInboundDigitalDocument​(String supportsInboundDigitalDocument)

      • getSupportsInboundDigitalDocument

        @Nullable
public String getSupportsInboundDigitalDocument()
        Indicates whether this mandate supports inbound digital documents
        Returns:
        supportsInboundDigitalDocument

      • setSupportsInboundDigitalDocument

        public void setSupportsInboundDigitalDocument​(String supportsInboundDigitalDocument)

      • getInputDataFormats

        @Nullable
public List<InputDataFormats> getInputDataFormats()
        Format and version used when inputting the data
        Returns:
        inputDataFormats

      • setInputDataFormats

        public void setInputDataFormats​(List<InputDataFormats> inputDataFormats)

      • getOutputDataFormats

        @Nullable
public List<OutputDataFormats> getOutputDataFormats()
        Lists the supported output document formats for the country mandate. For countries where specifying an output document format is required (e.g., France), this array will contain the applicable formats. For other countries where output format selection is not necessary, the array will be empty.
        Returns:
        outputDataFormats

      • setWorkflowIds

        public void setWorkflowIds​(List<WorkflowIds> workflowIds)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to Mandate

      • fromJson

        public static Mandate fromJson​(String jsonString)
                        throws IOException
        Create an instance of Mandate given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of Mandate
        Throws:
        IOException - if the JSON string is invalid with respect to Mandate

      • toJson

        public String toJson()
        Convert an instance of Mandate to an JSON string
        Returns:
        JSON string