Report Filing Service

<back to all web services

RetrieveDac6ProtocolsAsync

RetrieveDAC6Async

Represents a request to retrieve DAC6 protocols in an asynchronous operation.

Requires Authentication
The following routes are available for this service:
POST/async/elma/dac6/protocols/retrieve
RetrieveDac6ProtocolsBase Parameters:
NameParameterData TypeRequiredDescription
SearchCriteriaformSearchCriteriaYesThe parameters to search for protocols.
CredentialformElmaCredentialYesThe credential to gain access on the ELMA server.
StagingEnabledformbool?NoShould operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server.
SearchCriteria Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoFull or partial name of the item (report or protocol) to search.
DesignationformVerfahren?NoTThe ELMA product designation.
Verfahren Enum:
CC
CS
DC
FC
FS
FA
KM
ElmaCredential Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
CertificateformPemCertificateYesThe security certificate to authenticate the user and grant access to the ELMA server. This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start)
AuthSteuernummerformstringYesThe BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
AccountIdformstringYesThe account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
PasswordformstringYesThe password to protect the certificate from unauthorized access.
PemCertificate Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier (e.g. the file name) of the certificate.
ContentformstringYesThe PEM-encoded content of the certificate.
DescriptionformstringNoThe description of the certificate.
TagsformList<string>NoTags to label or identify the certificate.
RetrievalResponse Parameters:
NameParameterData TypeRequiredDescription
ProtocolsformList<Elma>NoProcessing logs that indicate the status of submitted reports.
FilesformList<BinaryFile>NoOther artefacts including the auxillary files from the BZSt.
ResponseStatusformResponseStatusNoThe status of the response.
Elma Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesThe unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
SchemaLocationformstringNoThe location of the XML Schema to use for the root namespace.
VerfahrenformVerfahren?YesThe type of reporting process.
ElmaKomformElmaKomYesThe communication section of the ELMA report document.
ElmaProtokollformElmaProtokollNoThe communication section of the ELMA report document.
ElmaFehlerformElmaFehlerNoThe communication section of the ELMA report document.
ElmaKom Parameters:
NameParameterData TypeRequiredDescription
ElmakomVersionformstringYesThe version number of the ELMAKOM definition.
ElmaHeaderformElmaHeaderYesThe header part of the ELMAKOM definition.
ElmaVerfahrenformElmaVerfahrenYesThe process part of the ELMAKOM definition.
ElmaHeader Parameters:
NameParameterData TypeRequiredDescription
DatenArtformDatenArtYesThe process-specific report type of an ELMA document.It distinguishes by the type of input.
AuthSteuernummerformstringYesThe BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
AccountIdformstringYesThe account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
ErstellungsDatumformDateTime?NoThe time of creation.Corresponds to the time, at which the user created a file.
KundeneigeneIdformstringNoUser custom ID.This field can be filled with internal reference information of the user.
UUIDformGuid?NoData transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
VerarbeitungslaufformVerarbeitungslaufNoDistinguishes between test and live data transfer.
DatenArt Enum:
ELMA_CC
ELMA_CCRM
ELMA_CRS
ELMA_CRSRM
ELMA_DC
ELMA_DCRM
ELMA_FC
ELMA_FCRM
Verarbeitungslauf Enum:
PRODUKTIONSLAUF
TESTLAUF
ElmaVerfahren Parameters:
NameParameterData TypeRequiredDescription
InhaltformObjectNoThe content of process-specific definition.
ElmaProtokoll Parameters:
NameParameterData TypeRequiredDescription
DateinameformstringNoFile name of the processed input ELMA report.
AuthSteuernummerformstringYesThe BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
AccountIdformstringYesThe account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
VerarbeitungsDatumformDateTime?NoDate on which the request was processed by ELAN (ELMA receiving server at BZSt).
VerarbeitungsZeitformDateTime?NoTime of processing by ELAN (ELMA receiving server at BZSt).
StatusformStatusNoThe status code of the ELMA process.
StatusTextformstringNoA brief description of the status.
StatusDetailformstringNoA detailed information on the status.
KundeneigeneIdformstringNoUser custom ID.This field can be filled with internal reference information of the user.
UUIDformGuid?NoData transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
Status Enum:
NameValue
ELMA_GLOBAL_UNBEKANNT0
ELMA_OK8000
ELMA_PARSER_FEHLER8001
ELMA_UNGUELTIGE_KODIERUNG8002
ELMA_UNGUELTIGE_DATEINAME8003
ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID8004
ELMA_SIGNATUR_DATEI_FEHLT8005
ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT8006
ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN8007
ELMA_FREISCHALTUNG_FEHLT8008
ELMA_SPERRE_VORHANDEN8009
ELMA_DATEINAME_BEREITS_VERWENDET8010
ELMA_DATEIINHALT_IDENTISCH8011
ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN8012
ELMA_TESTDATEN8013
ElmaFehler Parameters:
NameParameterData TypeRequiredDescription
DateinameformstringNoFile name of the processed input ELMA report.
AuthSteuernummerformstringYesThe BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information"
AccountIdformstringYesThe account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
VerarbeitungsDatumformDateTime?NoDate on which the request was processed by ELAN (ELMA receiving server at BZSt).
VerarbeitungsZeitformDateTime?NoTime of processing by ELAN (ELMA receiving server at BZSt).
FehlerIDformStatusNoThe status code of the ELMA process.
FehlerTextformstringNoA brief description of the error status.
FehlerProzessformstringNoA detailed information on the status.
KundeneigeneIdformstringNoUser custom ID.This field can be filled with internal reference information of the user.
UUIDformGuid?NoData transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000
BinaryFile Parameters:
NameParameterData TypeRequiredDescription
MetadataformFileMetadataNoThe attributes of the file.
NameformstringNoThe name of the file without information on its directory path.
FileBase Parameters:
NameParameterData TypeRequiredDescription
Contentformbyte[]NoThe raw data content of the file.
FileMetadata Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoThe name of the file. For files, gets the name of the file. For directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory.
FullNameformstringNoThe full path of the directory or file.
LastAccessTimeformDateTimeNoThe time the current file or directory was last accessed.
LastAccessTimeUtcformDateTimeNoThe name of the file.
LastWriteTimeformDateTimeNoThe time when the current file or directory was last written to.
LastWriteTimeUtcformDateTimeNoThe time, in coordinated universal time (UTC), when the current file or directory was last written to.
LengthformlongNoThe size, in bytes, of the current file.
UserIdformintNoThe size, in bytes, of the current file.
GroupIdformintNoThe file group id.
OthersCanReadformboolNoA value that indicates whether the others can read from this file.
GroupCanExecuteformboolNoA value that indicates whether the group members can execute this file.
GroupCanWriteformboolNoA value that indicates whether the group members can write into this file.
GroupCanReadformboolNoA value that indicates whether the group members can read from this file.
OwnerCanExecuteformboolNoA value that indicates whether the owner can execute this file.
OwnerCanWriteformboolNoA value that indicates whether the owner can write into this file.
OwnerCanReadformboolNoA value that indicates whether the owner can read from this file.
OthersCanExecuteformboolNoA value that indicates whether others can read from this file.
OthersCanWriteformboolNoA value that indicates whether others can write into this file.
ExtensionsformDictionary<string, string>NoExtensions to the file attributes.

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /async/elma/dac6/protocols/retrieve HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	searchCriteria: 
	{
		name: String,
		designation: CC
	},
	credential: 
	{
		id: String_String,
		certificate: 
		{
			id: String,
			content: String,
			description: String,
			tags: 
			[
				String
			]
		},
		authSteuernummer: String,
		accountId: String,
		password: String
	},
	stagingEnabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	protocols: 
	[
		{
			id: String,
			schemaLocation: String,
			verfahren: CC,
			elmaKom: 
			{
				elmakomVersion: String,
				elmaHeader: 
				{
					datenArt: ELMA_CC,
					authSteuernummer: String,
					accountId: String,
					erstellungsDatum: 0001-01-01,
					kundeneigeneId: String,
					uuid: 00000000000000000000000000000000,
					verarbeitungslauf: PRODUKTIONSLAUF
				},
				elmaVerfahren: 
				{
					inhalt: {}
				}
			},
			elmaProtokoll: 
			{
				dateiname: String,
				authSteuernummer: String,
				accountId: String,
				verarbeitungsDatum: 0001-01-01,
				verarbeitungsZeit: 0001-01-01,
				status: ELMA_GLOBAL_UNBEKANNT,
				statusText: String,
				statusDetail: String,
				kundeneigeneId: String,
				uuid: 00000000000000000000000000000000
			},
			elmaFehler: 
			{
				dateiname: String,
				authSteuernummer: String,
				accountId: String,
				verarbeitungsDatum: 0001-01-01,
				verarbeitungsZeit: 0001-01-01,
				fehlerID: ELMA_GLOBAL_UNBEKANNT,
				fehlerText: String,
				fehlerProzess: String,
				kundeneigeneId: String,
				uuid: 00000000000000000000000000000000
			}
		}
	],
	files: 
	[
		{
			metadata: 
			{
				name: String,
				fullName: String,
				lastAccessTime: 0001-01-01,
				lastAccessTimeUtc: 0001-01-01,
				lastWriteTime: 0001-01-01,
				lastWriteTimeUtc: 0001-01-01,
				length: 0,
				userId: 0,
				groupId: 0,
				othersCanRead: False,
				groupCanExecute: False,
				groupCanWrite: False,
				groupCanRead: False,
				ownerCanExecute: False,
				ownerCanWrite: False,
				ownerCanRead: False,
				othersCanExecute: False,
				othersCanWrite: False,
				extensions: 
				{
					String: String
				}
			},
			name: String,
			content: AA==
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}