Grid Owners

Server

Retrieve grid owner records and PTI invoice statistics.

List Grid Owners

GET

https://api-stag.utilitycloud.app

/be/v3/gridowners

Bearer (JWT)

Returns all grid owners for the tenant, optionally filtered by organization number. Each result includes PTI invoice counts for the current month: expected, imported, and paid. Use organizationNumber to filter results to a specific grid owner.

List Grid Owners › query Parameters

organizationNumber

string

Optional filter for returning grid owners with the specified organization number.

List Grid Owners › Responses

Success

be_api_v3_GridOwnerGetDto[]

be_api_v3_GridOwnerGetDto

id

string | null

gln

string | null

name

string | null

organizationNumber

string | null

priceArea

string | null

priceAreaName

string | null

ptiPrivate

boolean | null

ptiCorporate

boolean | null

array | null

usingEndDateStart

boolean | null

eventTime

string | null · date-time

manuallyUpdated

boolean | null

email

string | null

includeEmailOnInvoice

boolean | null

phone

string | null

includePhoneOnInvoice

boolean | null

website

string | null

includeWebsiteOnInvoice

boolean | null

gridOwnerInformation

string | null

gridOwnerInformationStart

string | null · date

gridOwnerInformationEnd

string | null · date

be_api_v3_Address

bankAccount

string | null

iban

string | null

taxVatCompanyId

string | null

taxCompanyId

string | null

bicCode

string | null

paymentRestricted

boolean | null

paymentNeglectNegative

boolean | null

isVisibleFrontend

boolean | null

object | null

invoicesExpectedThisMonth

integer | null · int32

invoicesImportedThisMonth

integer | null · int32

invoicesPaidThisMonth

integer | null · int32

GET/be/v3/gridowners

curl https://api-stag.utilitycloud.app/be/v3/gridowners \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "id",
    "gln": "gln",
    "name": "name",
    "organizationNumber": "organizationNumber",
    "priceArea": "priceArea",
    "priceAreaName": "priceAreaName",
    "ptiPrivate": true,
    "ptiCorporate": true,
    "sourceIdentification": [
      {
        "description": "description",
        "identification": "identification",
        "source": "source"
      }
    ],
    "usingEndDateStart": true,
    "eventTime": "2024-08-25T15:00:00Z",
    "manuallyUpdated": true,
    "email": "email",
    "includeEmailOnInvoice": true,
    "phone": "phone",
    "includePhoneOnInvoice": true,
    "website": "website",
    "includeWebsiteOnInvoice": true,
    "gridOwnerInformation": "gridOwnerInformation",
    "gridOwnerInformationStart": "2024-08-25",
    "gridOwnerInformationEnd": "2024-08-25",
    "address": {
      "type": "type",
      "postalCode": "postalCode",
      "city": "city",
      "countryCode": "countryCode",
      "poBox": "poBox",
      "careOf": "careOf",
      "attentionOf": "attentionOf",
      "onBehalfOf": "onBehalfOf",
      "roomIdentification": "roomIdentification",
      "floorIdentification": "floorIdentification",
      "buildingNumber": "buildingNumber",
      "streetName": "streetName",
      "streetCode": "streetCode",
      "citySubDivisionName": "citySubDivisionName"
    },
    "bankAccount": "bankAccount",
    "iban": "iban",
    "taxVatCompanyId": "taxVatCompanyId",
    "taxCompanyId": "taxCompanyId",
    "bicCode": "bicCode",
    "paymentRestricted": true,
    "paymentNeglectNegative": true,
    "isVisibleFrontend": true,
    "dimensions": {
      "key": {
        "number": 0,
        "value": {
          "id": "id",
          "name": "name",
          "value": "value",
          "customValue": true
        }
      }
    },
    "invoicesExpectedThisMonth": 0,
    "invoicesImportedThisMonth": 0,
    "invoicesPaidThisMonth": 0
  }
]

json

application/json

Get Grid Owner PTI Totals

GET

https://api-stag.utilitycloud.app

/be/v3/gridowners/pti

Bearer (JWT)

Returns PTI invoice totals for the specified grid owner. The response includes counts and amounts for imported, paid, and expected supplier invoices.

Get Grid Owner PTI Totals › query Parameters

gridownergln

string · required

The grid owner GLN.

Get Grid Owner PTI Totals › Responses

Success

be_api_v3_GridOwnerPtiDto

imported

integer · int32

importedAmount

number · double

paid

integer · int32

paidAmount

number · double

expected

integer · int32

PTI Service Types

API Reference

Grid Owners

Server

Download schema

Retrieve grid owner records and PTI invoice statistics.

List Grid Owners

GET

https://api-stag.utilitycloud.app

/be/v3/gridowners

Bearer (JWT)

List Grid Owners › query Parameters

organizationNumber

string

Optional filter for returning grid owners with the specified organization number.

List Grid Owners › Responses

Success

be_api_v3_GridOwnerGetDto[]

be_api_v3_GridOwnerGetDto

id

string | null

gln

string | null

name

string | null

organizationNumber

string | null

priceArea

string | null

priceAreaName

string | null

ptiPrivate

boolean | null

ptiCorporate

boolean | null

array | null

usingEndDateStart

boolean | null

eventTime

string | null · date-time

manuallyUpdated

boolean | null

email

string | null

includeEmailOnInvoice

boolean | null

phone

string | null

includePhoneOnInvoice

boolean | null

website

string | null

includeWebsiteOnInvoice

boolean | null

gridOwnerInformation

string | null

gridOwnerInformationStart

string | null · date

gridOwnerInformationEnd

string | null · date

be_api_v3_Address

bankAccount

string | null

iban

string | null

taxVatCompanyId

string | null

taxCompanyId

string | null

bicCode

string | null

paymentRestricted

boolean | null

paymentNeglectNegative

boolean | null

isVisibleFrontend

boolean | null

object | null

invoicesExpectedThisMonth

integer | null · int32

invoicesImportedThisMonth

integer | null · int32

invoicesPaidThisMonth

integer | null · int32

GET/be/v3/gridowners

curl https://api-stag.utilitycloud.app/be/v3/gridowners \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "id",
    "gln": "gln",
    "name": "name",
    "organizationNumber": "organizationNumber",
    "priceArea": "priceArea",
    "priceAreaName": "priceAreaName",
    "ptiPrivate": true,
    "ptiCorporate": true,
    "sourceIdentification": [
      {
        "description": "description",
        "identification": "identification",
        "source": "source"
      }
    ],
    "usingEndDateStart": true,
    "eventTime": "2024-08-25T15:00:00Z",
    "manuallyUpdated": true,
    "email": "email",
    "includeEmailOnInvoice": true,
    "phone": "phone",
    "includePhoneOnInvoice": true,
    "website": "website",
    "includeWebsiteOnInvoice": true,
    "gridOwnerInformation": "gridOwnerInformation",
    "gridOwnerInformationStart": "2024-08-25",
    "gridOwnerInformationEnd": "2024-08-25",
    "address": {
      "type": "type",
      "postalCode": "postalCode",
      "city": "city",
      "countryCode": "countryCode",
      "poBox": "poBox",
      "careOf": "careOf",
      "attentionOf": "attentionOf",
      "onBehalfOf": "onBehalfOf",
      "roomIdentification": "roomIdentification",
      "floorIdentification": "floorIdentification",
      "buildingNumber": "buildingNumber",
      "streetName": "streetName",
      "streetCode": "streetCode",
      "citySubDivisionName": "citySubDivisionName"
    },
    "bankAccount": "bankAccount",
    "iban": "iban",
    "taxVatCompanyId": "taxVatCompanyId",
    "taxCompanyId": "taxCompanyId",
    "bicCode": "bicCode",
    "paymentRestricted": true,
    "paymentNeglectNegative": true,
    "isVisibleFrontend": true,
    "dimensions": {
      "key": {
        "number": 0,
        "value": {
          "id": "id",
          "name": "name",
          "value": "value",
          "customValue": true
        }
      }
    },
    "invoicesExpectedThisMonth": 0,
    "invoicesImportedThisMonth": 0,
    "invoicesPaidThisMonth": 0
  }
]

json

application/json

Get Grid Owner PTI Totals

GET

https://api-stag.utilitycloud.app

/be/v3/gridowners/pti

Bearer (JWT)

Returns PTI invoice totals for the specified grid owner. The response includes counts and amounts for imported, paid, and expected supplier invoices.

Get Grid Owner PTI Totals › query Parameters

gridownergln

string · required

The grid owner GLN.

Get Grid Owner PTI Totals › Responses

Success

be_api_v3_GridOwnerPtiDto

imported

integer · int32

importedAmount

number · double

paid

integer · int32

paidAmount

number · double

expected

integer · int32

PTI Service Types