Package Avalara.SDK.model.EInvoicing.V1
Class FetchDocumentsRequestMetadata
- java.lang.Object
-
- Avalara.SDK.model.EInvoicing.V1.FetchDocumentsRequestMetadata
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.7.0") public class FetchDocumentsRequestMetadata extends Object
FetchDocumentsRequestMetadata
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFetchDocumentsRequestMetadata.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 FetchDocumentsRequestMetadata()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FetchDocumentsRequestMetadatacountryCode(String countryCode)FetchDocumentsRequestMetadatacountryMandate(String countryMandate)FetchDocumentsRequestMetadatadataFormat(String dataFormat)FetchDocumentsRequestMetadatadataFormatVersion(BigDecimal dataFormatVersion)booleanequals(Object o)static FetchDocumentsRequestMetadatafromJson(String jsonString)Create an instance of FetchDocumentsRequestMetadata given an JSON stringStringgetCountryCode()The two-letter ISO-3166 country code for the country for which document is being retrievedStringgetCountryMandate()The e-invoicing mandate for the specified countryStringgetDataFormat()Specifies the data format for this workflowBigDecimalgetDataFormatVersion()Specifies the data format version numberStringgetOutputDataFormat()Specifies the format of the output document to be generated for the recipient.BigDecimalgetOutputDataFormatVersion()Specifies the version of the selected output document formatStringgetWorkflowId()Specifies a unique ID for this workflow.inthashCode()FetchDocumentsRequestMetadataoutputDataFormat(String outputDataFormat)FetchDocumentsRequestMetadataoutputDataFormatVersion(BigDecimal outputDataFormatVersion)voidsetCountryCode(String countryCode)voidsetCountryMandate(String countryMandate)voidsetDataFormat(String dataFormat)voidsetDataFormatVersion(BigDecimal dataFormatVersion)voidsetOutputDataFormat(String outputDataFormat)voidsetOutputDataFormatVersion(BigDecimal outputDataFormatVersion)voidsetWorkflowId(String workflowId)StringtoJson()Convert an instance of FetchDocumentsRequestMetadata to an JSON stringStringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement)Validates the JSON Element and throws an exception if issues foundFetchDocumentsRequestMetadataworkflowId(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 FetchDocumentsRequestMetadata 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 FetchDocumentsRequestMetadata 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 FetchDocumentsRequestMetadata dataFormatVersion(BigDecimal dataFormatVersion)
-
getDataFormatVersion
@Nonnull public BigDecimal getDataFormatVersion()
Specifies the data format version number- Returns:
- dataFormatVersion
-
setDataFormatVersion
public void setDataFormatVersion(BigDecimal dataFormatVersion)
-
outputDataFormat
public FetchDocumentsRequestMetadata outputDataFormat(String outputDataFormat)
-
getOutputDataFormat
@Nonnull 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 FetchDocumentsRequestMetadata outputDataFormatVersion(BigDecimal outputDataFormatVersion)
-
getOutputDataFormatVersion
@Nonnull public BigDecimal getOutputDataFormatVersion()
Specifies the version of the selected output document format- Returns:
- outputDataFormatVersion
-
setOutputDataFormatVersion
public void setOutputDataFormatVersion(BigDecimal outputDataFormatVersion)
-
countryCode
public FetchDocumentsRequestMetadata countryCode(String countryCode)
-
getCountryCode
@Nonnull public String getCountryCode()
The two-letter ISO-3166 country code for the country for which document is being retrieved- Returns:
- countryCode
-
setCountryCode
public void setCountryCode(String countryCode)
-
countryMandate
public FetchDocumentsRequestMetadata 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 FetchDocumentsRequestMetadata
-
fromJson
public static FetchDocumentsRequestMetadata fromJson(String jsonString) throws IOException
Create an instance of FetchDocumentsRequestMetadata given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of FetchDocumentsRequestMetadata
- Throws:
IOException- if the JSON string is invalid with respect to FetchDocumentsRequestMetadata
-
toJson
public String toJson()
Convert an instance of FetchDocumentsRequestMetadata to an JSON string- Returns:
- JSON string
-
-