Package Avalara.SDK.model.EInvoicing.V1
Class SubmitDocumentMetadata
- java.lang.Object
-
- Avalara.SDK.model.EInvoicing.V1.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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubmitDocumentMetadata.CustomTypeAdapterFactory
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>openapiFieldsstatic HashSet<String>openapiRequiredFieldsstatic StringSERIALIZED_NAME_COUNTRY_CODEstatic StringSERIALIZED_NAME_COUNTRY_MANDATEstatic StringSERIALIZED_NAME_DATA_FORMATstatic StringSERIALIZED_NAME_DATA_FORMAT_VERSIONstatic StringSERIALIZED_NAME_OUTPUT_DATA_FORMATstatic StringSERIALIZED_NAME_OUTPUT_DATA_FORMAT_VERSIONstatic StringSERIALIZED_NAME_WORKFLOW_ID
-
Constructor Summary
Constructors Constructor Description SubmitDocumentMetadata()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SubmitDocumentMetadatacountryCode(String countryCode)SubmitDocumentMetadatacountryMandate(String countryMandate)SubmitDocumentMetadatadataFormat(String dataFormat)SubmitDocumentMetadatadataFormatVersion(String dataFormatVersion)booleanequals(Object o)static SubmitDocumentMetadatafromJson(String jsonString)Create an instance of SubmitDocumentMetadata given an JSON stringStringgetCountryCode()The two-letter ISO-3166 country code for the country where the document is being submittedStringgetCountryMandate()The e-invoicing mandate for the specified country.StringgetDataFormat()Specifies the data format for this workflow.StringgetDataFormatVersion()Specifies the data format version number.StringgetOutputDataFormat()Specifies the format of the output document to be generated for the recipient.StringgetOutputDataFormatVersion()Specifies the version of the selected output document formatStringgetWorkflowId()Specifies a unique ID for this workflow.inthashCode()SubmitDocumentMetadataoutputDataFormat(String outputDataFormat)SubmitDocumentMetadataoutputDataFormatVersion(String outputDataFormatVersion)voidsetCountryCode(String countryCode)voidsetCountryMandate(String countryMandate)voidsetDataFormat(String dataFormat)voidsetDataFormatVersion(String dataFormatVersion)voidsetOutputDataFormat(String outputDataFormat)voidsetOutputDataFormatVersion(String outputDataFormatVersion)voidsetWorkflowId(String workflowId)StringtoJson()Convert an instance of SubmitDocumentMetadata to an JSON stringStringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement)Validates the JSON Element and throws an exception if issues foundSubmitDocumentMetadataworkflowId(String workflowId)
-
-
-
Field Detail
-
SERIALIZED_NAME_WORKFLOW_ID
public static final String SERIALIZED_NAME_WORKFLOW_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DATA_FORMAT
public static final String SERIALIZED_NAME_DATA_FORMAT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DATA_FORMAT_VERSION
public static final String SERIALIZED_NAME_DATA_FORMAT_VERSION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_OUTPUT_DATA_FORMAT
public static final String SERIALIZED_NAME_OUTPUT_DATA_FORMAT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_OUTPUT_DATA_FORMAT_VERSION
public static final String SERIALIZED_NAME_OUTPUT_DATA_FORMAT_VERSION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_COUNTRY_CODE
public static final String SERIALIZED_NAME_COUNTRY_CODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_COUNTRY_MANDATE
public static final String SERIALIZED_NAME_COUNTRY_MANDATE
- See Also:
- Constant Field Values
-
-
Method Detail
-
workflowId
public SubmitDocumentMetadata workflowId(String workflowId)
-
getWorkflowId
@Nonnull public String getWorkflowId()
Specifies a unique ID for this workflow.- Returns:
- workflowId
-
setWorkflowId
public void setWorkflowId(String workflowId)
-
dataFormat
public SubmitDocumentMetadata dataFormat(String dataFormat)
-
getDataFormat
@Nonnull public String getDataFormat()
Specifies the data format for this workflow.- Returns:
- dataFormat
-
setDataFormat
public void setDataFormat(String dataFormat)
-
dataFormatVersion
public SubmitDocumentMetadata dataFormatVersion(String dataFormatVersion)
-
getDataFormatVersion
@Nonnull public String getDataFormatVersion()
Specifies the data format version number.- Returns:
- dataFormatVersion
-
setDataFormatVersion
public void setDataFormatVersion(String dataFormatVersion)
-
outputDataFormat
public SubmitDocumentMetadata outputDataFormat(String outputDataFormat)
-
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)
-
outputDataFormatVersion
public SubmitDocumentMetadata outputDataFormatVersion(String outputDataFormatVersion)
-
getOutputDataFormatVersion
@Nullable public String getOutputDataFormatVersion()
Specifies the version of the selected output document format- Returns:
- outputDataFormatVersion
-
setOutputDataFormatVersion
public void setOutputDataFormatVersion(String outputDataFormatVersion)
-
countryCode
public SubmitDocumentMetadata countryCode(String countryCode)
-
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)
-
countryMandate
public SubmitDocumentMetadata countryMandate(String countryMandate)
-
getCountryMandate
@Nonnull public String getCountryMandate()
The e-invoicing mandate for the specified country.- Returns:
- countryMandate
-
setCountryMandate
public void setCountryMandate(String countryMandate)
-
validateJsonElement
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOExceptionValidates 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
-
-