Class SubmitDocumentMetadata


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               comments="Generator version: 7.7.0")
    public class SubmitDocumentMetadata
    extends Object
    Key value pairs of metadata for a document submission <br><pre>{ \"workflowId\": \"partner-einvoicing\", \"dataFormat\": \"ubl-invoice\", \"dataFormatVersion\": \"2.1\", \"countryCode\": \"SA\", \"countryMandate\": \"SA-Phase1-B2B\" }</pre> <br>
    • Constructor Detail

      • SubmitDocumentMetadata

        public SubmitDocumentMetadata()
    • Method Detail

      • getWorkflowId

        @Nonnull
        public String getWorkflowId()
        Specifies a unique ID for this workflow.
        Returns:
        workflowId
      • setWorkflowId

        public void setWorkflowId​(String workflowId)
      • getDataFormat

        @Nonnull
        public String getDataFormat()
        Specifies the data format for this workflow.
        Returns:
        dataFormat
      • setDataFormat

        public void setDataFormat​(String dataFormat)
      • getDataFormatVersion

        @Nonnull
        public String getDataFormatVersion()
        Specifies the data format version number.
        Returns:
        dataFormatVersion
      • setDataFormatVersion

        public void setDataFormatVersion​(String dataFormatVersion)
      • getOutputDataFormat

        @Nullable
        public String getOutputDataFormat()
        Specifies the format of the output document to be generated for the recipient. This format should be chosen based on the recipient's preferences or requirements as defined by applicable e-invoicing regulations. When not specified for mandates that don't require a specific output format, the system will use the default format defined for that mandate.
        Returns:
        outputDataFormat
      • setOutputDataFormat

        public void setOutputDataFormat​(String outputDataFormat)
      • getOutputDataFormatVersion

        @Nullable
        public String getOutputDataFormatVersion()
        Specifies the version of the selected output document format
        Returns:
        outputDataFormatVersion
      • setOutputDataFormatVersion

        public void setOutputDataFormatVersion​(String outputDataFormatVersion)
      • getCountryCode

        @Nonnull
        public String getCountryCode()
        The two-letter ISO-3166 country code for the country where the document is being submitted
        Returns:
        countryCode
      • setCountryCode

        public void setCountryCode​(String countryCode)
      • getCountryMandate

        @Nonnull
        public String getCountryMandate()
        The e-invoicing mandate for the specified country.
        Returns:
        countryMandate
      • setCountryMandate

        public void setCountryMandate​(String countryMandate)
      • 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 SubmitDocumentMetadata
      • fromJson

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

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