Package net.webpdf.wsclient.openapi
Class OperationZugferdFileData
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationZugferdFileData
-
public class OperationZugferdFileData extends Object
ZUGFeRD file (XML) in \"Base64 encoded\" format. The ZUGFeRD XSD schema will be used to validate the file before embedding. If it is not valid, the operation will be aborted.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationZugferdFileData.SourceEnumSelects the data source for the hereby expressed resource.static classOperationZugferdFileData.VersionEnumUsed to define the version of the ZUGFeRD XML file that should be embedded with \"xmlFile\".
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_SOURCEstatic StringJSON_PROPERTY_URIstatic StringJSON_PROPERTY_VALUEstatic StringJSON_PROPERTY_VERSION
-
Constructor Summary
Constructors Constructor Description OperationZugferdFileData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)@Nullable OperationZugferdFileData.SourceEnumgetSource()Selects the data source for the hereby expressed resource.@Nullable StringgetUri()The uri the data shall be located at.@org.jetbrains.annotations.Nullable byte[]getValue()Get value@Nullable OperationZugferdFileData.VersionEnumgetVersion()Used to define the version of the ZUGFeRD XML file that should be embedded with \"xmlFile\".inthashCode()voidsetSource(OperationZugferdFileData.SourceEnum source)voidsetUri(String uri)voidsetValue(byte[] value)voidsetVersion(OperationZugferdFileData.VersionEnum version)OperationZugferdFileDatasource(OperationZugferdFileData.SourceEnum source)StringtoString()OperationZugferdFileDatauri(String uri)OperationZugferdFileDatavalue(byte[] value)OperationZugferdFileDataversion(OperationZugferdFileData.VersionEnum version)
-
-
-
Field Detail
-
JSON_PROPERTY_SOURCE
public static final String JSON_PROPERTY_SOURCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_URI
public static final String JSON_PROPERTY_URI
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VALUE
public static final String JSON_PROPERTY_VALUE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VERSION
public static final String JSON_PROPERTY_VERSION
- See Also:
- Constant Field Values
-
-
Method Detail
-
source
public OperationZugferdFileData source(OperationZugferdFileData.SourceEnum source)
-
getSource
@Nullable public @Nullable OperationZugferdFileData.SourceEnum getSource()
Selects the data source for the hereby expressed resource. Possible values are: * value = The element's value shall contain the BASE64 encoded data. * uri = The data shall be located at the given uri.- Returns:
- source
-
setSource
public void setSource(OperationZugferdFileData.SourceEnum source)
-
uri
public OperationZugferdFileData uri(String uri)
-
getUri
@Nullable public @Nullable String getUri()
The uri the data shall be located at. (This shall only have effect, if the \"source\" is \"uri\".)- Returns:
- uri
-
setUri
public void setUri(String uri)
-
value
public OperationZugferdFileData value(byte[] value)
-
getValue
@Nullable public @org.jetbrains.annotations.Nullable byte[] getValue()
Get value- Returns:
- value
-
setValue
public void setValue(byte[] value)
-
version
public OperationZugferdFileData version(OperationZugferdFileData.VersionEnum version)
-
getVersion
@Nullable public @Nullable OperationZugferdFileData.VersionEnum getVersion()
Used to define the version of the ZUGFeRD XML file that should be embedded with \"xmlFile\". Versions 1.0, 2.0, 2.1.x and 2.2 are supported. Only the \"Comfort\" profile is available for version 1.0. Meanwhile, the \"Minimum\", \"Basic WL\", \"Basic\", \"EN16931\" (Comfort), and \"Extended\" profiles are supported for version 2.0. **Note:** Since version 2.x, the referenced profile \"XRECHNUNG\" is additionally available. This profile has been included specifically to include invoices for Germany, based on and under the sole responsibility of KoSIT, Germany's central coordination agency for IT's e-invoice CIUS \"XRechnung\". It is defined as the Standard for electronic invoices issued to public administrations, and essentially adds specific business rules to EN 16931 in order to comply with national laws and regulations. **Note:** Since version 2.1.1 ZUGFeRD and Factur-X are technically identical and both formats use Factur-X as common identification. List of versions with the corresponding profiles: * v10Comfort * v20Minimum * v20BasicWL * v20Basic * v20EN16931 * v20Extended * v21Minimum * v21BasicWL * v21Basic * v21EN16931 * v21Extended * v21XRechnung * v22Minimum * v22BasicWL * v22Basic * v22EN16931 * v22Extended * v22XRechnung- Returns:
- version
-
setVersion
public void setVersion(OperationZugferdFileData.VersionEnum version)
-
-