MonopolX Edi API v1 (Alpha)¶

FileDispatched¶

Payload of an outbound message.

Field	Type	Description
tenant¶	string	The tenant this event belongs to.
message¶	bytes	The payload of the file.
filename¶	string	The filename of the message.
format¶	Format	The file format of the message.

InitialMasterDataReceived¶

Initial system master data for a building was received by the system. Mako: UTIMLD EoG wegen Einzug in Neuanlage

Field	Type	Rules	Description
tenant¶	string		The tenant this event belongs to.
sender¶	string		Message sender MP-ID.
receiver¶	string		Message receiver MP-ID.
message_type¶	string		Message type, always "UTILMD"
connection_object¶	InitialMasterDataReceived.ConnectionObject		The connection object.
premise¶	InitialMasterDataReceived.Premise		The premise.
installation¶	InitialMasterDataReceived.Installation		The installation.
malo¶	string		Malo
devices¶	InitialMasterDataReceived.Device	repeated	The devices of the installation.
partner¶	InitialMasterDataReceived.Partner		The partner.
contract¶	InitialMasterDataReceived.Contract		The contract.
begin_time¶	google.protobuf.Timestamp		Time when the system was created.
transaction_id¶	string		Transaction / Correlation id of the process.
message¶	string		The message id of the original message.

InitialMasterDataReceived.ConnectionObject¶

Field	Type	Rules	Description
address¶	enpowerx.types.PostalAddress		Address of the connection object.
description¶	string		Description of the connection object.

InitialMasterDataReceived.Contract¶

Field	Type	Description
commodity¶	enpowerx.monopolx.types.Commodity	Commodity of the installation.
supplier_reading_regular_cycle_date¶	enpowerx.monopolx.types.DayOfMonth	The regular reading date by supplier business partner.
billing_cycle¶	enpowerx.monopolx.types.BillingCycle	The billing cycle of the contract.
consumption_prognosis¶	enpowerx.types.Decimal	Consumption prognosis for the contract.

InitialMasterDataReceived.Device¶

Field	Type	Rules	Description
type¶	InitialMasterDataReceived.Device.EnergyType		Energy type of the device info.
meter_number¶	string		Number of the meter.
meter_type¶	string		Type of the meter, e.g. "AHZ" (See MSCONS).
meter_type_details¶	string		Meter type details.
counter_size¶	InitialMasterDataReceived.Device.CounterSize		Counter size.
data_acquisition_method¶	InitialMasterDataReceived.Device.DataAcquisitionMethod		Data acquisition method
description¶	string		Description of the device.
registers¶	InitialMasterDataReceived.Device.Register	repeated	The registers of the device.

InitialMasterDataReceived.Device.Register¶

Field	Type	Description
obis¶	string	Obis of the register.
melo¶	string	Melo of the register.
melo_active_period¶	enpowerx.types.DateRange	Active period of the register.
integer_digits¶	int32	Integer digits of the register (i.e. digits before the decimal point)
fractional_digits¶	int32	Fractional digits of the register. (i.e. digits after the decimal point)
description¶	string	Description of the register.

InitialMasterDataReceived.Installation¶

Field	Type	Rules	Description
commodity¶	enpowerx.monopolx.types.Commodity		Commodity of the installation.
description¶	string		Description of the installation.

InitialMasterDataReceived.Partner¶

Field	Type	Rules	Description
company¶	InitialMasterDataReceived.Partner.Company		Present if partner is a company
person¶	InitialMasterDataReceived.Partner.Person		Present if partner is a person
address¶	enpowerx.types.PostalAddress		The default address of the partner.
additional_addresses¶	enpowerx.types.PostalAddress	repeated	Additional addresses of the partner.

InitialMasterDataReceived.Partner.Company¶

Field	Type	Rules	Description
company_name¶	string		The company name.

InitialMasterDataReceived.Partner.Person¶

Field	Type	Description
salutation¶	string	salutation
title¶	string	title
lastname¶	string	lastname
firstname¶	string	firstname

InitialMasterDataReceived.Premise¶

Field	Type	Rules	Description
floor¶	string		The floor of the building.
description¶	string		Description of the premise.

InitialMasterDataReceived.Device.CounterSize¶

Name	Number	Description
COUNTER_SIZE_UNSPECIFIED	0	Counter size is not specified
QN_2_5	1	Counter size is QN 2.5
QN_6	2	Counter size is QN 6
QN_10	3	Counter size is QN 10
QN_15	4	Counter size is QN 15
QN_40	5	Counter size is QN 40
QN_60	6	Counter size is QN 60
QN_150	7	Counter size is QN 150

InitialMasterDataReceived.Device.DataAcquisitionMethod¶

Name	Number	Description
DATA_ACQUISITION_METHOD_UNSPECIFIED	0	Data acquisition method is not specified
READ_OUT_MANUAL	1	Manual read out.
READ_OUT_REMOTE	2	Remote read out.

InitialMasterDataReceived.Device.EnergyType¶

Name	Number	Description
ENERGY_TYPE_UNSPECIFIED	0	Unknown energy type.
WATER	1	Energy type is water.
HEAT	2	Energy type is heat.

Files¶

List and View files of Messages

ListFiles¶

List Files.

Input: FilesListRequest¶

Field	Type	Description
*parent¶	string	The parent resource id.
*tenant¶	string	The tenant to list connection object for.
page_size¶	int32	The maximum number of items to return. 0 for default.
page_token¶	string	The `next_page_token` value returned from a previous List request, if any.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-created_time".

Output: ListFilesResponse¶

Field	Type	Rules	Description
files¶	File	repeated	A list of message files.
total_size¶	int32		Count of items contained in the list.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

GetFile¶

Get a Single File.

Output: File¶

Field	Type	Rules	Description
tenant¶	string	output only	The tenant of the mapping.
id¶	string	output only	The unique id of the tenant
kind¶	File.Kind	output only	The kind of the file.
file_name¶	string	output only	The name of the file.
size¶	int64	output only	size of the file in bytes.
create_time¶	google.protobuf.Timestamp	output only	The creation time of the file.

GetFileContents¶

Get file content.

Output: GetFileContentsResponse¶

Field	Type	Rules	Description
content¶	bytes		The result contents of the file.

File.Kind¶

Name	Number	Description
KIND_UNSPECIFIED	0	Kind is not specified.
SOURCE	1	File is a source file.
RESULT	2	File is a result

Mappings¶

Manage EDI transmission related configuration.

ListMappings¶

List mappings.

Input: MappingsListRequest¶

Field	Type	Description
*tenant¶	string	The tenant to list connection object for.
page_size¶	int32	The maximum number of items to return. 0 for default.
page_token¶	string	The `next_page_token` value returned from a previous List request, if any.
filter¶	MappingsListRequest.Filter	The filter to apply to the list.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-created_time".

Output: MappingsListResponse¶

Field	Type	Rules	Description
mappings¶	Mapping	repeated	A list of mappings.
total_size¶	int32		Count of items contained in the list.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

GetMapping¶

Get a mapping identified by its ID.

Output: Mapping¶

Field	Type	Rules	Description
*tenant¶	string		The of the mapping.
*id¶	string	immutable	The unique id of the mapping
*source_format¶	Format		The source format of the mapping.
*target_format¶	Format		The source format of the mapping.
*message_type¶	string		Type of the message e.g. MSCONS
*sender¶	string		MP-ID of the sender.
*receiver¶	string		MP-ID of the receiver.
matching_rule¶	string		Additional matching rule for the message using CEL. The matching rule must evaluate to true or false.
event¶	string		Protobuf type name of the generated/trigger event, e.g. enpowerx.monopolx.events.metering.ReadingsReceivedV1 This field is required if the target or source format is PROTOBUF.
*mapper¶	string		Defines the mapping of the message to the generated event using CEL. The mapping rule must generate the specified event for inbound mappings. For outbound mappings a transmission must be generated.
application_reference¶	string		Application reference for OUTGOING messages (e.g. EM, TL or VL for MSCONS).
test¶	bool	optional	Determines if outgoing messages shall be send with the test marker.
ttl¶	google.protobuf.Duration		The ttl of the generated event.
*active¶	bool		Indicates if the mapping is active.
description¶	string		Optional description of the mapping.
create_time¶	google.protobuf.Timestamp	output only	The creation time of the mapping.
update_time¶	google.protobuf.Timestamp	output only	The last update time of the mapping.

CreateMapping¶

Create a new inbound mapping.

Input: Mapping¶

Field	Type	Rules	Description
*tenant¶	string		The of the mapping.
*id¶	string	immutable	The unique id of the mapping
*source_format¶	Format		The source format of the mapping.
*target_format¶	Format		The source format of the mapping.
*message_type¶	string		Type of the message e.g. MSCONS
*sender¶	string		MP-ID of the sender.
*receiver¶	string		MP-ID of the receiver.
matching_rule¶	string		Additional matching rule for the message using CEL. The matching rule must evaluate to true or false.
event¶	string		Protobuf type name of the generated/trigger event, e.g. enpowerx.monopolx.events.metering.ReadingsReceivedV1 This field is required if the target or source format is PROTOBUF.
*mapper¶	string		Defines the mapping of the message to the generated event using CEL. The mapping rule must generate the specified event for inbound mappings. For outbound mappings a transmission must be generated.
application_reference¶	string		Application reference for OUTGOING messages (e.g. EM, TL or VL for MSCONS).
test¶	bool	optional	Determines if outgoing messages shall be send with the test marker.
ttl¶	google.protobuf.Duration		The ttl of the generated event.
*active¶	bool		Indicates if the mapping is active.
description¶	string		Optional description of the mapping.
create_time¶	google.protobuf.Timestamp	output only	The creation time of the mapping.
update_time¶	google.protobuf.Timestamp	output only	The last update time of the mapping.

Output: Mapping¶

Field	Type	Rules	Description
*tenant¶	string		The of the mapping.
*id¶	string	immutable	The unique id of the mapping
*source_format¶	Format		The source format of the mapping.
*target_format¶	Format		The source format of the mapping.
*message_type¶	string		Type of the message e.g. MSCONS
*sender¶	string		MP-ID of the sender.
*receiver¶	string		MP-ID of the receiver.
matching_rule¶	string		Additional matching rule for the message using CEL. The matching rule must evaluate to true or false.
event¶	string		Protobuf type name of the generated/trigger event, e.g. enpowerx.monopolx.events.metering.ReadingsReceivedV1 This field is required if the target or source format is PROTOBUF.
*mapper¶	string		Defines the mapping of the message to the generated event using CEL. The mapping rule must generate the specified event for inbound mappings. For outbound mappings a transmission must be generated.
application_reference¶	string		Application reference for OUTGOING messages (e.g. EM, TL or VL for MSCONS).
test¶	bool	optional	Determines if outgoing messages shall be send with the test marker.
ttl¶	google.protobuf.Duration		The ttl of the generated event.
*active¶	bool		Indicates if the mapping is active.
description¶	string		Optional description of the mapping.
create_time¶	google.protobuf.Timestamp	output only	The creation time of the mapping.
update_time¶	google.protobuf.Timestamp	output only	The last update time of the mapping.

UpdateMapping¶

Update an existing inbound mapping.

Input: UpdateMappingRequest¶

Field	Type	Rules	Description
*mapping¶	Mapping		The mapping to update.
*update_mask¶	google.protobuf.FieldMask		The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Output: Mapping¶

Field	Type	Rules	Description
*tenant¶	string		The of the mapping.
*id¶	string	immutable	The unique id of the mapping
*source_format¶	Format		The source format of the mapping.
*target_format¶	Format		The source format of the mapping.
*message_type¶	string		Type of the message e.g. MSCONS
*sender¶	string		MP-ID of the sender.
*receiver¶	string		MP-ID of the receiver.
matching_rule¶	string		Additional matching rule for the message using CEL. The matching rule must evaluate to true or false.
event¶	string		Protobuf type name of the generated/trigger event, e.g. enpowerx.monopolx.events.metering.ReadingsReceivedV1 This field is required if the target or source format is PROTOBUF.
*mapper¶	string		Defines the mapping of the message to the generated event using CEL. The mapping rule must generate the specified event for inbound mappings. For outbound mappings a transmission must be generated.
application_reference¶	string		Application reference for OUTGOING messages (e.g. EM, TL or VL for MSCONS).
test¶	bool	optional	Determines if outgoing messages shall be send with the test marker.
ttl¶	google.protobuf.Duration		The ttl of the generated event.
*active¶	bool		Indicates if the mapping is active.
description¶	string		Optional description of the mapping.
create_time¶	google.protobuf.Timestamp	output only	The creation time of the mapping.
update_time¶	google.protobuf.Timestamp	output only	The last update time of the mapping.

DryRunMapping¶

Dry run a mapping. This will return the result of the mapping without actually sending a transmission or dispatching an event.

Input: DryRunMappingRequest¶

Field	Type	Description
*tenant¶	string	The tenant of the mapping.
*id¶	string	The unique id of the mapping
*input¶	bytes	The raw input to process. The format is detected automatically. Currently supported formats are: - EDIFACT - CSV (must be RFC 4180 compliant; Supported field separators are `,`, `;` and `\|`) - JSON (must be protojson representation of google.protobuf.Any) - Protobuf (must be google.protobuf.Any)
pretty_print¶	bool	Pretty print the output. Defaults to false.

Output: DryRunMappingResponse¶

Field	Type	Rules	Description
results¶	bytes	repeated	List of generated results. Currently this is a JSON encoded CloudEvent. The Payload depends on the target format.

MappingsListRequest.Filter¶

Field	Type	Rules	Description
source_formats¶	Format	repeated	Filter by source format.
target_formats¶	Format	repeated	Filter by target format.
message_type_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
message_type_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
sender_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
sender_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
receiver_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
receiver_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
event_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
event_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
active¶	bool	optional	Filter by active state.

Format¶

Name	Number	Description
FORMAT_UNSPECIFIED	0	Format is not specified.
EDIFACT	1	EDIFACT format.
CSV	2	CSV format.
PROTOBUF	3	Protobuf format.

Messages¶

List and View messages sent or received by the system.

ListMessages¶

List messages.

Input: MessagesListRequest¶

Field	Type	Description
*tenant¶	string	The tenant to list connection object for.
page_size¶	int32	The maximum number of items to return. 0 for default.
page_token¶	string	The `next_page_token` value returned from a previous List request, if any.
filter¶	MessagesListRequest.Filter	The filter to apply to the list.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-created_time".

Output: ListMessagesResponse¶

Field	Type	Rules	Description
messages¶	Message	repeated	A list of messages.
total_size¶	int32		Count of items contained in the list.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

SearchMessages¶

Search messages

Input: SearchMessagesRequest¶

Field	Type	Description
*tenant¶	string	The tenant to list connection object for.
*search_term¶	string	The search term to use. This is a free text search term, which searches the contents of the source and result message. The following syntax is supported: - `term` - search for the term `term` - `"hello world"` - search for the exact phrase `hello world` - `hello -world` - search for the term `hello` but not `world`
page_size¶	int32	The maximum number of items to return. 0 for default.
page_token¶	string	The `next_page_token` value returned from a previous List request, if any.
filter¶	SearchMessagesRequest.Filter	The filter to apply to the list.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-created_time". If not specified the results are ordered by relevance.

Output: SearchMessagesResponse¶

Field	Type	Rules	Description
messages¶	Message	repeated	A list of messages.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

GetMessage¶

Get a message.

Output: Message¶

Field	Type	Rules	Description
tenant¶	string	output only	The tenant of the mapping.
id¶	string	output only	The unique id of the tenant
format¶	Format	output only	The format of the generated data.
reference¶	string	output only	Reference of the message. Either the id of the event or the DAR.
type¶	string	output only	The type of the message, e.g. "MSCONS"
sender¶	string	output only	Sender of the message.
receiver¶	string	output only	Receiver of the message.
filename¶	string	output only	File name of the original/final message.
event¶	string	output only	Event that triggered the message or was triggered by the message.
state¶	Message.State	output only	The state of the message.
mapping¶	string	output only	Mappings that has been used to process the message.
dispatch_time¶	google.protobuf.Timestamp	output only	The time when the message was dispatched.
source¶	string	output only	The source identifier of the message. This is either the filename or the event.
source_format¶	Format	output only	The format of the source.
create_time¶	google.protobuf.Timestamp	output only	The creation time of the message.
update_time¶	google.protobuf.Timestamp	output only	The last update time of the message.

ListMessageLogs¶

List message logs.

Input: MessageLogEntriesListRequest¶

Field	Type	Description
*parent¶	string	The parent resource id.
*tenant¶	string	The tenant to list connection object for.
page_size¶	int32	The maximum number of items to return. 0 for default.
page_token¶	string	The `next_page_token` value returned from a previous List request, if any.
filter¶	MessageLogEntriesListRequest.Filter	The filter to apply to the list.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-created_time".

Output: ListMessageLogEntriesResponse¶

Field	Type	Rules	Description
message_log_entries¶	MessageLogEntry	repeated	A list of message log entries.
total_size¶	int32		Count of items contained in the list.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

SubmitMessage¶

Manually submit a new message.

Input: SubmitMessageRequest¶

Field	Type	Description
*tenant¶	string	The tenant of the mapping.
*input¶	bytes	The raw input to process. The format is detected automatically. Currently supported formats are: - EDIFACT - CSV (must be RFC 4180 compliant; Supported field separators are `,`, `;` and `\|`) - JSON (must be protojson representation of google.protobuf.Any) - Protobuf (must be google.protobuf.Any)
filename¶	string	The filename to use for the message. If not specified a random filename will be generated.

Output: SubmitMessageResponse¶

Field	Type	Rules	Description
messages¶	Message	repeated	The messages that were created.

AddProcessorAnnotation¶

Add a processor annotation to a message. This is used to mark a message as processed by a specific processor.

Input: AddProcessorAnnotationRequest¶

Field	Type	Rules	Description
tenant¶	string	output only	The tenant of the mapping.
id¶	string	output only	The unique id of the tenant
*processor¶	string		The processor which handles the message.
*failed¶	bool		Indicates if the processor failed.
annotations¶	google.protobuf.Struct		Additional information.

Output: AddProcessorAnnotationResponse¶

Field	Type	Rules	Description
message_log_entry¶	MessageLogEntry		The created message log entry.

MessageLogEntriesListRequest.Filter¶

Field	Type	Rules	Description
severity¶	MessageLogEntry.Severity	repeated	Filter by severity.
codes¶	string	repeated	Filter by error codes.
create_time_time¶	enpowerx.types.DateTimeFilter		Filter by start date on the specified date.
create_time_range¶	enpowerx.types.DateTimeRangeFilter		Filter by start date in the specified range

MessageLogEntry¶

Field	Type	Rules	Description
tenant¶	string	output only	The tenant of the mapping.
id¶	string	output only	The unique id of the tenant
severity¶	MessageLogEntry.Severity	output only	The severity of the log entry.
code¶	string	output only	Codified message
annotations¶	google.protobuf.Struct	output only	Additional information about the log entry.
create_time¶	google.protobuf.Timestamp	output only	The creation time of the log entry.

MessagesListRequest.Filter¶

Field	Type	Rules	Description
formats¶	Format	repeated	Filter by formats.
reference_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
reference_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
type_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
type_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
sender_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
sender_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
receiver_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
receiver_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
filename_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
filename_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
event_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
event_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
states¶	Message.State	repeated	Filter by state.
mappings¶	string	repeated	Filter by messages
dispatch_time_time¶	enpowerx.types.DateTimeFilter		Filter by start date on the specified date.
dispatch_time_range¶	enpowerx.types.DateTimeRangeFilter		Filter by start date in the specified range
source_scalar¶	enpowerx.types.StringScalarFilter		Filter for one value.
source_list¶	enpowerx.types.StringListFilter		Filter for multiple values.
source_formats¶	Format	repeated	Filter by source formats

SearchMessagesRequest.Filter¶

Field	Type	Rules	Description
formats¶	Format	repeated	Filter by formats.
types¶	string	repeated	Filter by message type.
events¶	string	repeated	Filter by event.
states¶	Message.State	repeated	Filter by state.
dispatch_time_range¶	enpowerx.types.DateTimeRangeFilter		Filter by dispatch time.
sources¶	string	repeated	Filter by source.
source_formats¶	Format	repeated	Filter by source formats

Message.State¶

Name	Number	Description
STATE_UNSPECIFIED	0	State is not specified.
QUEUED	1	Message is queued.
SENT	2	Message is sent.
RETRY	3	Message is being retried.
FAILED	4	Message sending failed.
ERROR	5	Message failed due to a processing error.

MessageLogEntry.Severity¶

Name	Number	Description
SEVERITY_UNSPECIFIED	0	Severity is not specified.
INFO	2	Severity is info.
WARNING	3	Severity is warning.
ERROR	4	Severity is error.

Shared Types¶

Amount¶

Field	Type	Description
unit¶	string	The unit of the amount. E.g.'kWh' or 'PCS' for pieces.
units¶	int64	The whole units of the amount. For example if `unit` is `"PCS"`, then 1 unit is one piece.
nanos¶	int32	Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

BankAccount¶

Information about a bank account.

Field	Type	Description
*iban¶	string	The International Bank Account Number.
bic¶	string	The Bank Identifier Code.
account_holder¶	string	The name of the account holder.
bank¶	string	The name of the bank.

CustomerType¶

Represents the kind of the customer.

Name	Number	Description
CUSTOMER_TYPE_UNSPECIFIED	0	The customer type is unspecified.
PRIVATE	1	The customer type is private.
BUSINESS	2	The customer type is business.
BOTH	3	The customer type is private and business.

DateRange¶

Represents a range of dates.

Field	Type	Description
*start¶	google.type.Date	The inclusive start date.
end¶	google.type.Date	The inclusive end date.
end_exclusive¶	google.type.Date	The exclusive end date.
time_zone¶	string	The time zone of the date range (defaults to Europe/Berlin).

DateTimeRange¶

Represents a range of date times.

Field	Type	Rules	Description
*start¶	google.protobuf.Timestamp		The inclusive start date.
end¶	google.protobuf.Timestamp		The inclusive end date.

Decimal¶

Field	Type	Rules	Description
units¶	int64		The whole units of the amount.
nanos¶	int32		Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Billing¶

Billing details.

Field	Type	Description
*contact¶	Contact	The contact to send invoices to.
*payment_method¶	PaymentMethod	The payment method method.
bank_account¶	BankAccount	The bank account used if `payment_method` is `DIRECT_DEBIT`.

CommunicationChannel¶

Communication channel.

Name	Number	Description
COMMUNICATION_CHANNEL_UNSPECIFIED	0	Channel not specified.
LETTER	1	Send messages via letter.
EMAIL	2	Send messages via email.
SMS	3	Send messages via SMS.
MESSENGER	4	Send messages via messenger apps like WhatsApp.
PHONE	5	Communicate via telephone.

Contact¶

Contact details (postal, phone, etc.).

Field	Type	Description
*person¶	Person	Information on how to address the contact.
postal_address¶	PostalAddress	The contact's postal address.
phone_number¶	string	The phone number of the contact. Values are normalized into the form `+123456789`.
email¶	string	The email address of the contact.
careof¶	Person	A person that may receive communication in the name of the actual recipient (e.g. a "C/O" line added to the postal address).

Reading¶

Information about a reading.

Field	Type	Rules	Description
*date¶	google.type.Date		The date when the reading was taken.
channel¶	Reading.Channel		How the reading was reported. This is value is ignored when submitting via `AddMine`.
*values¶	Reading.ValuesEntry	repeated	A map of values to submit with OBIS codes as the key.
ignore_plausibility_check_reason¶	google.protobuf.StringValue		If set the meter reading(s) will be saved, even if they're not plausible. Specifies the reason why the plausibility check is to be ignored.

Reading.ValuesEntry¶

Field	Type	Rules	Description
key¶	string
value¶	double

Reading.Channel¶

Name	Number	Description
CHANNEL_UNSPECIFIED	0	No channel specified.
PORTAL	1	Reported via end-user portal.
EMAIL	2	Reported via email.
LETTER	3	Reported via letter.
PHONE	4	Reported via phone call.
MSCONS	5	Reported via Metered Services Consumption report message.

Relocation¶

Information about the relocation of an contract.

Field	Type	Description
*contract¶	string	The contract's ID this request is targeting.
*moveout_date¶	google.type.Date	The move-out date.
*movein_date¶	google.type.Date	The move-in date.
*delivery¶	EnergyDelivery	Which kind and amount of energy is to be delivered to where.
*use_new_address¶	Relocation.UseNewAddress	Use the new address as postal and billing address.
*meter¶	string	The ID of the meter at the new consumption point.
last_reading¶	Reading	The last reading at the old consumption point.
old_meter¶	string	The ID of the meter at the old consumption point. Optional, must be set if a last reading is provided.

Relocation.UseNewAddress¶

Name	Number	Description
USE_NEW_ADDRESS_UNSPECIFIED	0	Use unspecified.
NO	1	Use not desired.
IMMEDIATELY	2	Use immediately desired.
ON_MOVE_IN	3	Use on moving in desired.

SalesInfo¶

Information on how a sale was made.

Field	Type	Description
sales_partner_code¶	string	Direct sales partner code.
sales_partner_code_second¶	string	Second direct sales partner code.
campaign¶	string	Optional override for the default campaign.

ScheduledRequest¶

Reference to an entity with an optional scheduled starting date.

Field	Type	Rules	Description
*id¶	string		The ID referencing the entity.
scheduled_date¶	google.type.Date		The scheduled starting date (earliest possible if unset).

TransitionType¶

Specifies modalities of a contract transition.

Name	Number	Description
TRANSITION_TYPE_UNSPECIFIED	0	The transition type is unspecified
MANUAL_TERMINATION	1	The customer terminates the prior contract.
VENDOR_TERMINATION	2	The vendor terminates the prior contract.
RELOCATION	3	The customer is going to or has recently moved to the new address.

Duration¶

Represents a coarse time duration (e.g., 2 months).

Field	Type	Rules	Description
*units¶	int32		The number of time units.
*type¶	google.type.CalendarPeriod		The type the units refer to (days, months, etc.).

EnergyDelivery¶

Describes which kind and amount of energy is to be delivered to where.

Field	Type	Description
*energy_type¶	EnergyType	The kind of the energy.
*customer_type¶	CustomerType	The kind of the customer.
*address¶	PostalAddress	The address to deliver energy to.
annual_usage¶	int32	The estimated power usage in kWh per year.
usage_type¶	EnergyDelivery.UsageType	The usage type for the delivered energy.
annual_usage_nt¶	int32	The estimated off-peak power usage in kWh per year (DE: Niedertarifverbrauch).

EnergyDelivery.UsageType¶

Name	Number	Description
USAGE_TYPE_UNSPECIFIED	0	The consumption type is unspecified.
HOUSEHOLD_ELECTRICITY	1	The energy is used for household.
CHARGING_CURRENT	2	The energy is used for charging.
STORAGE_HEATER	3	The energy is used for a storage heater.
HEAT_PUMP	4	The energy is used for a heat pump.
HOUSEHOLD_ELECTRICITY_AND_STORAGE_HEATER	5	The energy is used for household with storage heater.
HOUSEHOLD_ELECTRICITY_AND_HEAT_PUMP	6	The energy is used for household with heat pump.

EnergyType¶

Represents the kind of the energy.

Name	Number	Description
ENERGY_TYPE_UNSPECIFIED	0	The energy type is unspecified.
ELECTRICITY	1	The energy type is electricity.
GAS	2	The energy type is gas.

FileContent¶

Field	Type	Rules	Description
*mime_type¶	string		The media type / content type of the document.
*content¶	bytes		The raw data of the document.

AnnotationFilter¶

AnnotationFilter provides filter semantics for annotations.

Field	Type	Rules	Description
*field¶	string		The annotation field path is a symbolic field path to target an annotation's field, for example: "invoice.id", "is_consumption_based", ...
value¶	google.protobuf.Value		The value to match the annotation field's value.

DateFilter¶

DateFilter provides match semantics for date fields.

Field	Type	Rules	Description
*date¶	google.type.Date		The date to filter for.
match_mode¶	DateFilter.MatchMode		The match mode to use. The default is EQUAL.

DateRangeFilter¶

DateTimeRangeFilter provides match semantics for date fields. The filter treats the start and end date as inclusive.

Field	Type	Rules	Description
*start_date¶	google.type.Date		The start date to filter for.
*end_date¶	google.type.Date		The end date to filter for.

DateTimeFilter¶

DateTimeFilter provides match semantics for date time fields.

Field	Type	Rules	Description
*time¶	google.protobuf.Timestamp		The date time to filter for.
match_mode¶	DateTimeFilter.MatchMode		The match mode to use. The default is EQUAL.

DateTimeRangeFilter¶

DateTimeRangeFilter provides match semantics for date time fields.

Field	Type	Rules	Description
*start_time¶	google.protobuf.Timestamp		The start date time to filter for.
*end_time¶	google.protobuf.Timestamp		The end date time to filter for.

StringListFilter¶

Strings filter x IN and x NOT IN semantics.

Field	Type	Rules	Description
*values¶	string	repeated	The value to filter for.
negate¶	bool		If true the expression is negated.

StringScalarFilter¶

StringFilter provides match semantics for strings fields.

Field	Type	Description
*value¶	string	The value to filter for.
match_mode¶	StringScalarFilter.MatchMode	The match mode to use.
negate¶	bool	If true the expression is negated.

DateFilter.MatchMode¶

Name	Number	Description
MATCH_MODE_UNSPECIFIED	0	The match mode is unspecified.
EQUAL	1	Filter only matches if the date is equal to the provided date.
BEFORE	2	Filter matches all dates that are before the provided date.
AFTER	3	Filter matches all dates that are after the provided date.
BEFORE_OR_EQUAL	4	Filter matches all dates that are before or equal to the provided date.
AFTER_OR_EQUAL	5	Filter matches all dates that are after or equal to the provided date.

DateTimeFilter.MatchMode¶

Name	Number	Description
MATCH_MODE_UNSPECIFIED	0	The match mode is unspecified.
EQUAL	1	Filter only matches if the date is equal to the provided date.
BEFORE	2	Filter matches all dates that are before the provided date.
AFTER	3	Filter matches all dates that are after the provided date.
BEFORE_OR_EQUAL	4	Filter matches all dates that are before or equal to the provided date.
AFTER_OR_EQUAL	5	Filter matches all dates that are after or equal to the provided date.

StringScalarFilter.MatchMode¶

Name	Number	Description
MATCH_MODE_UNSPECIFIED	0	The match mode is unspecified.
EXACT	1	Filter only matches if the field contains exactly the expected value.
PREFIX	2	Filter matches all fields that are prefixed with the given value.
SUFFIX	3	Filter matches all fields that are suffixed with the given value.
SUBSTRING	4	Filter matches all fields that contain the given value.

LetterAddress¶

Combines a name and a postal address.

Field	Type	Description
*person¶	Person	The person being addressed.
careof¶	string	A person that may receive letters in the name of the actual recipient (e.g. a "C/O" line added to the postal address).
*postal_address¶	PostalAddress	The postal address.

MonthOfYear¶

Represents a month of a year.

Field	Type	Rules	Description
month¶	int32		Month of the year.
year¶	int32		Year.

PaymentMethod¶

Possible methods for paying invoices.

Name	Number	Description
PAYMENT_METHOD_UNSPECIFIED	0	The payment method method is unspecified.
DIRECT_DEBIT	1	Money is automatically withdrawn from the specified bank account.
MANUAL_TRANSFER	2	The customer pays bills manually using money transfers.

Period¶

A period of time with inclusive start and inclusive and exclusive end time. If both (inclusive and exclusive) ends are specified, they must be consistent. If no end is specified, the period is considered unbounded on the end. If the time is unspecified it is considered to be 00:00:00.000000000 for the start (and exclusive end) and 23:59:59.999999999 for the inclusive end.

The following example represents a period of time from 2006-01-01 to 2006-01-31: { start_time: { hours: 0 minutes: 0 seconds: 0 nanos: 0 } start_date: { year: 2006 month: 1 day: 1 } end_time: { hours: 23 minutes: 59 seconds: 59 nanos: 999999999 } end_date: { year: 2006 month: 1 day: 31 } end_date_exclusive: { year: 2006 month: 2 day: 1 } end_time_exclusive: { hours: 0 minutes: 0 seconds: 0 nanos: 0 } }

Field	Type	Description
start_time¶	google.type.TimeOfDay	The start time of the period (inclusive).
end_time¶	google.type.TimeOfDay	The end time of the period (inclusive).
start_date¶	google.type.Date	The start date of the period (inclusive).
end_date¶	google.type.Date	The end date of the period (inclusive).
end_time_exclusive¶	google.type.TimeOfDay	The end time of the period (exclusive).
end_date_exclusive¶	google.type.Date	The end date of the period (exclusive).
time_zone¶	string	The time zone of the period (defaults to Europe/Berlin).

Person¶

Information on how to address a person. A person can be either a natural person or a company with an optional contact Natural Person: Must provide firstname, lastname Company: Must provide company

Field	Type	Description
salutation¶	Person.SalutationForm	The salutation of the person.
title¶	string	The title of the person.
firstname¶	string	The first name of the person.
lastname¶	string	The last name of the person.
birthday¶	google.type.Date	The birthday of the person.
company¶	string	The company name.

Person.SalutationForm¶

Name	Number	Description
SALUTATION_FORM_UNSPECIFIED	0	The salutation form is unspecified.
MRS	1	The salutation form is `Mrs.`.
MR	2	The salutation form is `Mr.`.
DIVERSE	3	The salutation form is `Diverse`.
FAMILY	4	The salutation form is `Family`.

PostalAddress¶

Represents a postal address, e.g. for postal delivery or payments addresses.

Field	Type	Rules	Description
*region¶	string		The region the address is located in as a CLDR region code. Example: `DE` for Germany
*postal_code¶	string		A postal code of the city (a city may have more than one). Example: `76131` for Karlsruhe inner city
*city¶	string		The canonical name of the city (there may be more than one per postal code). Example: `Karlsruhe`
street¶	string		The canonical name of the street. Example: `Kaiserstr.`
house_number¶	string		The house number. Examples: `32`, `32a`, `32/1`
postbox_number¶	string		Postbox number in case address is a postbox.
district¶	string		Administrative division (i.e. Stadtteil).
additional_address_lines¶	string	repeated	Additional address lines Example: Appartment 104, Care of etc.

Price¶

Represents a price before and after taxes.

Field	Type	Description
*net¶	google.type.Money	The price without VAT.
*gross¶	google.type.Money	The price including VAT.
unit¶	string	The unit the price is related to (e.g "kWh", "PCS", "month", etc.)

Quantity¶

Field	Type	Description
unit¶	string	The unit of the quantity. E.g.'kWh' or 'PCS' for pieces.
units¶	int64	The whole units of the quantity. For example if `unit` is `"PCS"`, then 1 unit is one piece.
nanos¶	int32	Number of nano (10^-9) units of the quantity. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

RecurringCost¶

Represents a price/cost that repeats at a fixed interval.

Field	Type	Rules	Description
*price¶	Price		The price per interval.
*interval¶	google.type.CalendarPeriod		The interval at which the cost occurs (per day, month, etc.).

TenantScopedListRequest¶

Field	Type	Description
*tenant¶	string	The tenant the list belongs to.
page_size¶	int32	The maximum number of items to return. 0 for default.
page_token¶	string	The `next_page_token` value returned from a previous List request, if any.

TenantScopedResource¶

A tenant scoped resource.

Field	Type	Rules	Description
*tenant¶	string		The tenant the resource belongs to.
*id¶	string		The ID of the resource.

TimeRange¶

A range of time with inclusive start, inclusive and exclusive end time. If both (inclusive and exclusive) ends are specified, they must be consistent. If no end is specified, the period is considered unbounded on the end.

Field	Type	Description
start¶	google.protobuf.Timestamp	The inclusive start.
end¶	google.protobuf.Timestamp	The inclusive end.
end_exclusive¶	google.protobuf.Timestamp	The exclusive end.

File-level Extensions¶

Extension	Type	Base	Number	Description
throws	string	.google.protobuf.MethodOptions	76131	throws is used to document error messages that the method might return in status.details.

CalendarPeriod¶

A CalendarPeriod represents the abstract concept of a time period that has a canonical start. Grammatically, "the start of the current CalendarPeriod." All calendar times begin at midnight UTC.

Name	Number	Description
CALENDAR_PERIOD_UNSPECIFIED	0	Undefined period, raises an error.
DAY	1	A day.
WEEK	2	A week. Weeks begin on Monday, following ISO 8601.
FORTNIGHT	3	A fortnight. The first calendar fortnight of the year begins at the start of week 1 according to ISO 8601.
MONTH	4	A month.
QUARTER	5	A quarter. Quarters start on dates 1-Jan, 1-Apr, 1-Jul, and 1-Oct of each year.
HALF	6	A half-year. Half-years start on dates 1-Jan and 1-Jul.
YEAR	7	A year.

Date¶

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

A full date, with non-zero year, month, and day values
A month and day value, with a zero year, such as an anniversary
A year on its own, with zero month and day values
A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Field	Type	Description
year¶	int32	Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month¶	int32	Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day¶	int32	Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

Money¶

Represents an amount of money with its currency type.

Field	Type	Description
currency_code¶	string	The three-letter currency code defined in ISO 4217.
units¶	int64	The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
nanos¶	int32	Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.

Scalar Value Types¶

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)

Legend¶

*) required