Accounting API v3 (Alpha)¶

Balances¶

Manage balances in APAX

GetAccountBalance¶

Get account balances for a contract.

Input: GetAccountBalanceRequest¶

Field	Type	Rules	Description
*name¶	string		The contract's fully qualified name

Output: AccountBalance¶

Field	Type	Rules	Description
name¶	string	output only	The resource's fully qualified name.
amount¶	google.type.Money	output only	The amount.
amount_overdue¶	google.type.Money	output only	The overdue amount.

ListAccountBalances¶

List account balances for a customer

Input: ListAccountBalancesRequest¶

Field	Type	Description
*parent¶	string	The customer the accounts belong 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.
filter¶	string	The filter to be applied on all contracts.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-next_cancellation_date".

Output: ListAccountBalancesResponse¶

Field	Type	Rules	Description
account_balances¶	AccountBalance	repeated	The account balances for this customer.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

GetAccountDetails¶

Get specific account details

Input: GetAccountDetailsRequest¶

Field	Type	Rules	Description
*name¶	string		The contract's fully qualified name

Output: AccountDetails¶

Field	Type	Rules	Description
name¶	string	output only	The resource's fully qualified name.
details¶	Details	output only repeated	The account details.

Details¶

Field	Type	Rules	Description
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
description¶	string	output only	The description.
state¶	DocumentState	output only	The document state (Beleg Status).
due_date¶	google.type.Date		Due date.
post_date¶	google.type.Date		Post date.
document_number¶	string		The document number.
reference_doc_number¶	string		The reference document number (Druckbelegnummer/Referenzbelegnummer).
invoice_number¶	string		The invoice number (Rechnungsnummer).
clear_doc_number¶	string		The clear document number (Ausgleichsbelegnummer).
type¶	DocumentHierarchyType		The document hierarchy type.
items¶	DetailsItem	repeated	Details Items.

DetailsItem¶

Field	Type	Rules	Description
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
description¶	string	output only	The description.
state¶	DocumentState	output only	The document state (Beleg Status).
due_date¶	google.type.Date		Due date.
post_date¶	google.type.Date		Post date.
document_number¶	string		The document number.
reference_doc_number¶	string		The reference document number (Druckbelegnummer/Referenzbelegnummer).
clear_doc_number¶	string		The clear document number (Ausgleichsbelegnummer).
type¶	DocumentHierarchyType		The document hierarchy type.

DocumentHierarchyType¶

Name	Number	Description
DOCUMENT_HIERARCHY_TYPE_UNSPECIFIED	0	The document hierarchy type is unspecified.
DOCUMENT_HIERARCHY_TYPE_POSITION	1	The document hierarchy type is position (Belegposition).
DOCUMENT_HIERARCHY_TYPE_PAYMENT	2	The document hierarchy type is payment (Zahlung).
DOCUMENT_HIERARCHY_TYPE_DOCUMENT	3	The document hierarchy type is document (Beleg).

DocumentState¶

Name	Number	Description
DOCUMENT_STATE_UNSPECIFIED	0	The document state is unspecified.
DOCUMENT_STATE_BALANCED	1	The document state is balanced (Ausgeglichen).
DOCUMENT_STATE_DUE	2	The document state is due (Fällig).
DOCUMENT_STATE_CANCELED	3	The document state is canceled (Storniert).
DOCUMENT_STATE_DEFERED	4	The document state is deferred (In Stundung).
DOCUMENT_STATE_INSTALLMENT	5	The document state is in installment (In Ratenzahlung).
DOCUMENT_STATE_OPEN	6	The document state is open (Offen).

Deferrals¶

Manage deferrals.

GetDeferral¶

Get a Deferral.

Input: GetDeferralRequest¶

Field	Type	Rules	Description
*name¶	string		The deferral's fully qualified name.

Output: Deferral¶

Field	Type	Rules	Description
name¶	string		The resource's fully qualified name.
*end_date¶	google.type.Date		The end date of the deferrals.
claims¶	Claim	output only repeated	The claims for a deferral for this contract.
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
due_date¶	google.type.Date	output only	The date that the record is due.

ListDeferrals¶

List deferrals.

Input: ListDeferralsRequest¶

Field	Type	Description
*parent¶	string	The contract the deferrals belong 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.
filter¶	string	The filter to be applied on all contracts.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-next_cancellation_date".

Output: ListDeferralsResponse¶

Field	Type	Rules	Description
deferrals¶	Deferral	repeated	The deferrals for this contract.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

CreateDeferral¶

Create a deferral.

Input: CreateDeferralRequest¶

Field	Type	Description
*parent¶	string	The resource's parent.
*deferral¶	Deferral	The deferral to be created.
*deferral_id¶	string	The document ID of the record which should be deferred

Output: Deferral¶

Field	Type	Rules	Description
name¶	string		The resource's fully qualified name.
*end_date¶	google.type.Date		The end date of the deferrals.
claims¶	Claim	output only repeated	The claims for a deferral for this contract.
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
due_date¶	google.type.Date	output only	The date that the record is due.

ExtendDeferral¶

Extend a deferral.

Input: ExtendDeferralRequest¶

Field	Type	Rules	Description
*name¶	string		The deferral's fully qualified name.
*end_date¶	google.type.Date		The end date of the deferrals.

Output: Deferral¶

Field	Type	Rules	Description
name¶	string		The resource's fully qualified name.
*end_date¶	google.type.Date		The end date of the deferrals.
claims¶	Claim	output only repeated	The claims for a deferral for this contract.
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
due_date¶	google.type.Date	output only	The date that the record is due.

DeactivateDeferral¶

Deactivate a deferral.

Input: DeactivateDeferralRequest¶

Field	Type	Rules	Description
*name¶	string		The deferral's fully qualified name.

Dunning¶

Manage dunning related resources (-- api-linter: core::0121::resource-must-support-get=disabled aip.dev/not-precedent: Not supported by upstream API. --)

GetBalance¶

Get the balance for a specific account

Input: GetBalanceRequest¶

Field	Type	Rules	Description
*name¶	string		The account balance's fully qualified name

Output: Balance¶

(-- api-linter: core::0123::resource-name-components-alternate=disabled aip.dev/not-precedent: Format requested by architect. --)

Field	Type	Rules	Description
name¶	string		Name of the balance
balances¶	Balance.Balance	output only repeated	Balance Breakdown (DE: Salden)
records¶	Balance.Record	output only repeated	Business records which compose the claim (DE: Einzel-Belege)
blocks¶	Balance.Block	output only repeated	Dunning blocks (DE: Mahnsperren)

CreateCharge¶

Create a new debitor account record

Input: CreateChargeRequest¶

Field	Type	Description
*parent¶	string	The parent resource
*charge¶	Charge	The dunning charge to be created.
charge_id¶	string	The ID of the account record

Output: Charge¶

(-- api-linter: core::0123::resource-name-components-alternate=disabled aip.dev/not-precedent: Format requested by architect. --)

Field	Type	Rules	Description
name¶	string	output only	Name of the account record
due_date¶	google.type.Date		Due date (DE: Fälligkeitsdatum)
creation_date¶	google.type.Date		Creation date (DE: Erstelldatum des Buchungsvorfalls beim Consumer)
*amount¶	google.type.Money		Amount of the transaction (DE: Bruttobetrag)
tax_rate¶	enpowerx.types.v3.Decimal		Tax rate (DE: Steuersatz)

ResetLevel¶

Reset the dunning level of a contract

Input: ResetLevelRequest¶

Field	Type	Rules	Description
*name¶	string		The contract's fully qualified name

Balance.Balance¶

Field	Type	Rules	Description
kind¶	Balance.Balance.Kind	output only	Kind of the balance
amount_open¶	google.type.Money	output only	Open amount
amount_overdue¶	google.type.Money	output only	Overdue amount

Balance.Block¶

Dunning Block (DE: Mahnsperre)

Field	Type	Rules	Description
active_range¶	enpowerx.types.v3.DateRange	output only	Date range when the block is active
change_date¶	google.type.Date	output only	Change date

Balance.Record¶

Business record (DE: Beleg)

Field	Type	Rules	Description
type¶	string	output only	type of the record (DE: SAP-Kurzbezeichnung)
description¶	string	output only	Description of the record (DE: Belegart)
number¶	string	output only	fica number (DE: FICA-Belegnummer)
reference¶	string	output only	Reference (DE: Druckbeleg/Rechnungsnummer)
date¶	google.type.Date	output only	date of the record (DE: Belegdatum)
due_date¶	google.type.Date	output only	due date of the record (DE: Fälligkeitsdatum)
amount¶	google.type.Money	output only	Amount of the record (DE: Amount)

Balance.Balance.Kind¶

Name	Number	Description
KIND_UNSPECIFIED	0	Balance kind is unspecified
PRINCIPAL_CLAIM	1	Principal claim (DE: Hauptforderungen)
SECONDARY_CLAIM	2	Secondary claim amount (DE: Nebenforderungen)
INSTALLMENTS	3	Installments (DE: Abschläge)
DOWN_PAYMENTS	4	Down payments (DE: Raten)
SUM_CLAIMS	5	Total amount of claims (DE: Summe Forderungen)
DEPOSITS	6	Deposits (DE: Zahlungen / Guthaben)
SUM_DEPOSITS	7	Sum deposits (DE: Summe Guthaben)
BALANCE	8	Balance (DE: Saldo)

Installments¶

Manage installments in APAX

SubmitInstallment¶

Submit an installment plan

Input: SubmitInstallmentRequest¶

Field	Type	Rules	Description
*name¶	string		The resource's name
*installment¶	Installment		The installment to be submitted

Installment¶

Field	Type	Description
*name¶	string	The resource's parent
due_date¶	google.type.Date	The date at which the installment is due.
amount¶	google.type.Money	The amount of the installment.
tax_rate¶	float	The tax rate of the installment.
commodity¶	enpowerx.types.v3.Commodity	The commodity which the installment is for

Invoices¶

Manage invoices in APAX

CreateInvoice¶

Create an invoice
(-- api-linter: core::0133::response-message-name=disabled
aip.dev/not-precedent: We need to do this because the create process is asynchronous and we cannot return the response immediately. --)

Input: CreateInvoiceRequest¶

Field	Type	Description
*parent¶	string	The resource's name
*invoice¶	Invoice	The bill to be created
*invoice_id¶	string	The ID to use for the invoice

BillingLine¶

Field	Type	Description
commodity¶	enpowerx.types.v3.Commodity	The billing line's commodity.
*sales_tax_rate¶	float	The applied sales tax rate in percent (%). The values are in the range from 0.0 to 99.99.
*sales_tax¶	google.type.Money	The sales tax. This can be calculated using the `net_total` and the `sales_tax_rate`. The result is commercially rounded.
*net_total¶	google.type.Money	The net total.
*gross_total¶	google.type.Money	The gross total.
period¶	enpowerx.types.v3.Period	The billing line's period.
group¶	string	The group e.g. section this billing line belongs to in a bill.
source¶	string	The billing line's source (e.g a price component type reference or a invoice article, etc).

Invoice¶

Field	Type	Rules	Description
*name¶	string		The resource's name
*predecessor¶	string		The bill's predecessor
*corrected¶	string		The ID of the bill that has to be corrected
*bill_type¶	BillType		The bill's type
*commit_time¶	google.protobuf.Timestamp		The commit time of the bill
*currency_code¶	string		The currency code of the billing positions
*period¶	enpowerx.types.v3.DateRange		The bill's period.
sales_tax_exemption_reason¶	string		The reason for the exemption from sales tax. Needed when the sales tax rate is set to 0.
*lines¶	BillingLine	repeated	The billing lines.
is_batch_process¶	bool		Signals if request originates from batch process
*cancel_time¶	google.protobuf.Timestamp		The cancel time of the bill

BillType¶

Name	Number	Description
BILL_TYPE_UNSPECIFIED	0	The bill type is unspecified.
BILL_TYPE_REGULAR_CYCLE	1	The bill originates from a regular billing cycle.
BILL_TYPE_MANUAL	2	The bill originates from a manual billing.
BILL_TYPE_INTERMEDIATE	3	The bill originates from an intermediate billing.
BILL_TYPE_CANCELLATION	4	The bill originates from a cancellation.
BILL_TYPE_YEAR_BALANCE	5	The bill balances the whole calender year.
BILL_TYPE_FINAL	6	The final bill of a contract period.

PaymentPlans¶

Manage payment plans in APAX

GetPaymentPlan¶

Get a PaymentPlan

Input: GetPaymentPlanRequest¶

Field	Type	Rules	Description
*name¶	string		The payment plan's fully qualified name

Output: PaymentPlan¶

Field	Type	Rules	Description
name¶	string	output only	The resource's fully qualified name.
status¶	string	output only	The status of the payment plan.
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
claims¶	Claim	output only repeated	The claims.
*start_date¶	google.type.Date		The date that the payment plan starts.
end_date¶	google.type.Date	output only	The date that the payment plan ends.
create_date¶	google.type.Date	output only	The date that the payment plan was created.
duration_months¶	int32	input only	The duration in months.
has_fee¶	bool	input only	Whether there is a fee for the payment plan or not. Defaults to false.
partial_payment_allowed¶	bool	input only optional	Whether partial payment is allowed.

ListPaymentPlanEligibleClaims¶

List claims which can be used to create a payment plan

Input: ListPaymentPlanEligibleClaimsRequest¶

Field	Type	Description
*parent¶	string	The contract the payment plan belong 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.
filter¶	string	The filter to be applied on all contracts.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-next_cancellation_date".

Output: ListPaymentPlanEligibleClaimsResponse¶

Field	Type	Rules	Description
payment_plan_eligible_claims¶	PaymentPlanClaim	repeated	The claims for a payment plan for this contract.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

CreatePaymentPlan¶

Create a PaymentPlan

Input: CreatePaymentPlanRequest¶

(-- api-linter: core::0133::request-id-field=disabled aip.dev/not-precedent: We need to do this because apax generates a unique payment plan number. --)

Field	Type	Rules	Description
*parent¶	string		The resource's parent.
*payment_plan¶	PaymentPlan		The payment plan to be created.

Output: PaymentPlan¶

Field	Type	Rules	Description
name¶	string	output only	The resource's fully qualified name.
status¶	string	output only	The status of the payment plan.
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
claims¶	Claim	output only repeated	The claims.
*start_date¶	google.type.Date		The date that the payment plan starts.
end_date¶	google.type.Date	output only	The date that the payment plan ends.
create_date¶	google.type.Date	output only	The date that the payment plan was created.
duration_months¶	int32	input only	The duration in months.
has_fee¶	bool	input only	Whether there is a fee for the payment plan or not. Defaults to false.
partial_payment_allowed¶	bool	input only optional	Whether partial payment is allowed.

DeactivatePaymentPlan¶

Deactivate a PaymentPlan

Input: DeactivatePaymentPlanRequest¶

Field	Type	Rules	Description
*name¶	string		The payment plan's fully qualified name.
*reason¶	DeactivationReason		The reason for the deactivation.

ListPaymentPlans¶

List PaymentPlans

Input: ListPaymentPlansRequest¶

Field	Type	Description
*parent¶	string	The contract the payment plan belong 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.
filter¶	string	The filter to be applied on all contracts.
order_by¶	string	Comma separated list of fields to order by. Use - for descending order, e.g. "-next_cancellation_date".

Output: ListPaymentPlansResponse¶

Field	Type	Rules	Description
payment_plans¶	PaymentPlan	repeated	The PaymentPlans for this contract.
next_page_token¶	string		Token to retrieve the next page of results, or empty if there are no more results in the list.

Claim¶

Field	Type	Rules	Description
*doc_number¶	string		The document number.
description¶	string	output only	The description.
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
due_date¶	google.type.Date	output only	The date that the installment is due.
position¶	string	optional	The position.
repetition_position¶	string	optional	The repetition position.
sub_position¶	string	optional	The sub position.

PaymentPlanClaim¶

Field	Type	Rules	Description
document_number¶	string	output only	The document number.
reference_doc_number¶	string	output only	The reference document number (Druckbelegnummer/Referenzbelegnummer).
description¶	string	output only	The description.
amount¶	google.type.Money	output only	The amount.
open_amount¶	google.type.Money	output only	The open amount.
claims¶	Claim	output only repeated	The claims.
due_date¶	google.type.Date	output only	The date that the claim is due.

DeactivationReason¶

Name	Number	Description
DEACTIVATION_REASON_UNSPECIFIED	0	The reason is unspecified.
DUNNING	1	Deactivation via dunning (Deaktivierung durch Mahnlauf)
MANUAL	2	Manual deactivation (Deaktivierung manuell)
CANCELLATION	3	Cancellation bill (Storno Rechnung)
CANCELLATION_BALANCED	4	Cancellation - payment plan already balanced (Storno Rechn - RP ber. Ausgegl)

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