Contracting API v3 (Alpha)¶

MonopolxContractsAdapter¶

MonopolX PSFS Contracting API Adapter.

GetContract¶

Get a specific contract.

ListContracts¶

List contracts with optional filters.
Due to performance limitation, this method is restricted to return a maximum of 50 contracts per call.

CreateContract¶

Create a contract.

CommodityB2CContractSubjectDetails¶

ContractTariff¶

ContractTariff.GraduatedPrice¶

ContractTariff.GraduatedPrice.WorkingPrice¶

RegisterType¶

Address¶

The address of a legal entity. At least one of the following must be set.

Contact¶

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

Person¶

Person.SalutationForm¶

Contracts¶

Manage contracts.

GetContract¶

Get a specific contract.

Input: GetContractRequest¶

Output: Contract¶

ContractB2CDetails¶

Only exists to generate b2c contract details messages.
(-- api-linter: core::0127::http-annotation=disabled
aip.dev/not-precedent: We need to do this because we want to generate documentation for unused messages. --)

Input: GetContractRequest¶

ContractMonopolXDetails¶

Only exists to generate monopolX contract details messages.
(-- api-linter: core::0127::http-annotation=disabled
aip.dev/not-precedent: We need to do this because we want to generate documentation for unused messages. --)

Input: GetContractRequest¶

ListContracts¶

List contracts with optional filters.

Input: ListContractsRequest¶

Output: ListContractsResponse¶

CreateContract¶

TODO: unklar
Create a contract.

Input: CreateContractRequest¶

Output: Contract¶

GetStateHistory¶

Get a specific contract's state history.

Input: GetStateHistoryRequest¶

Output: StateHistory¶

GetRenewalHistory¶

Get a specific contract's renewal history.

Input: GetRenewalHistoryRequest¶

Output: RenewalHistory¶

RenewContract¶

Renew a contract.

Input: RenewContractRequest¶

Output: RenewalHistory¶

GetBillingDetailsHistory¶

Get a specific contract's billing details history.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have billing details as one word which
is not very readable --)

Input: GetBillingDetailsHistoryRequest¶

Output: BillingDetailsHistory¶

RegisterBillingDetails¶

Register new billing details for a contract.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have billing details as one word which
is not very readable --)

Input: BillingDetails¶

Output: BillingDetailsHistory¶

CancelContract¶

Cancel a specific contract.

Input: ContractCancelRequest¶

UpdateContract¶

Update contract.

Input: UpdateContractRequest¶

Output: Contract¶

ListMine¶

List contracts for the current customer (identity from OAuth token).

Input: ListContractsRequest¶

Output: ListContractsResponse¶

GetMine¶

Get a specific contract for the current customer (identity from OAuth token).

Input: MyContractRequest¶

Output: Contract¶

Contract.Subject¶

ContractIDRequest¶

StateEntry¶

Contract.BillingCycle¶

Initiator¶

StateEntry.State¶

CustomerType¶

Represents the kind of the customer.

Customers¶

Manage customers.

GetCustomer¶

Get a specific customer.

Input: GetCustomerRequest¶

Output: Customer¶

CreateCustomer¶

Create a specific customer.
If a customer with the the same 'legal_contact' already exists,
the request will fail with ALREADY_EXISTS and return the existing customer's name.

Input: CreateCustomerRequest¶

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

Output: Customer¶

UpdateCustomer¶

Update a customer.

Input: UpdateCustomerRequest¶

Output: Customer¶

ListCustomers¶

List customers with optional filters.

Input: ListCustomersRequest¶

Output: ListCustomersResponse¶

GetMe¶

Get the current customer (identity from OAuth token).
(-- api-linter: core::0131::response-message-name=disabled
aip.dev/not-precedent: We need to do this because we want to return the customer object of the requester. --)

Input: GetMeRequest¶

Output: Customer¶

ImpersonateCustomer¶

Impersonate a customer. The impersonating identity is taken from the OAuth token.

Input: GetCustomerRequest¶

GetBankAccount¶

Get a bank account.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have bank accounts as one word which
is not very readable --)

Input: GetBankAccountRequest¶

Output: BankAccount¶

CreateBankAccount¶

Create a new bank account for a customer.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have bank accounts as one word which
is not very readable --)

Input: CreateBankAccountRequest¶

Output: BankAccount¶

ListBankAccounts¶

List bank accounts for a customer.
(-- api-linter: core::0127::http-template-syntax=disabled
aip.dev/not-precedent: We need to do this because otherwise we would have bank accounts as one word which
is not very readable --)

Input: ListBankAccountsRequest¶

Output: ListBankAccountsResponse¶

GetContact¶

Get a specific contact.

Input: GetContactRequest¶

CreateContact¶

Create a contact.

Input: CreateContactRequest¶

UpdateContact¶

Update a contact.

Input: UpdateContactRequest¶

BankAccountRequest¶

EnergyDelivery¶

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

EnergyDelivery.UsageType¶

ContractAborted¶

ContractCancelled¶

ContractCreated¶

ContractRenewed¶

ContractUpdated¶

CustomerBankAccountCreated¶

CustomerCreated¶

CustomerUpdated¶

MonopolXContractSubjectDetails¶

MonopolXContractSubjectDetails.ConsumptionPrognosis¶

MonopolXContractSubjectDetails.DeliveryLocation¶

MonopolXContractSubjectDetails.Meter¶

PaymentMethod¶

Possible methods for paying invoices.

RecurringCost¶

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

Shared Types¶

Amount¶

BankAccount¶

Information about a bank account.

CustomerType¶

Represents the kind of the customer.

DateRange¶

Represents a range of dates.

DateTimeRange¶

Represents a range of date times.

Decimal¶

Billing¶

Billing details.

CommunicationChannel¶

Communication channel.

Contact¶

Contact details (postal, phone, etc.).

Reading¶

Information about a reading.

Reading.ValuesEntry¶

Reading.Channel¶

Relocation¶

Information about the relocation of an contract.

Relocation.UseNewAddress¶

SalesInfo¶

Information on how a sale was made.

ScheduledRequest¶

Reference to an entity with an optional scheduled starting date.

TransitionType¶

Specifies modalities of a contract transition.

Duration¶

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

EnergyDelivery¶

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

EnergyDelivery.UsageType¶

EnergyType¶

Represents the kind of the energy.

FileContent¶

AnnotationFilter¶

AnnotationFilter provides filter semantics for annotations.

DateFilter¶

DateFilter provides match semantics for date fields.

DateRangeFilter¶

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

DateTimeFilter¶

DateTimeFilter provides match semantics for date time fields.

DateTimeRangeFilter¶

DateTimeRangeFilter provides match semantics for date time fields.

StringListFilter¶

Strings filter x IN and x NOT IN semantics.

StringScalarFilter¶

StringFilter provides match semantics for strings fields.

DateFilter.MatchMode¶

DateTimeFilter.MatchMode¶

StringScalarFilter.MatchMode¶

LetterAddress¶

Combines a name and a postal address.

MonthOfYear¶

Represents a month of a year.

PaymentMethod¶

Possible methods for paying invoices.

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 } }

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

Person.SalutationForm¶

PostalAddress¶

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

Price¶

Represents a price before and after taxes.

Quantity¶

RecurringCost¶

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

TenantScopedListRequest¶

TenantScopedResource¶

A tenant scoped 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.

File-level Extensions¶

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.

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.

Money¶

Represents an amount of money with its currency type.

Scalar Value Types¶

Legend¶