Invoices - All

This endpoint allows you to retrieve a list of invoices' data based on the specified date range.

get/api/invoices

Request

Base URL
https://apiclearing.test.nordpoolgroup.com
URL
https://apiclearing.test.nordpoolgroup.com/api/invoices
Auth
API key in header Authorization

Query parameters

fromDeliveryDatestring date required

Start date of delivery. Expected format: yyyy-MM-dd.

toDeliveryDatestring date required

End date of delivery. Expected format: yyyy-MM-dd.

showOnlyUnpaidboolean

If set to true, only invoices that have not been paid will be returned. If set to false or not specified, all invoices within the specified date range will be returned, regardless of payment status.

includeSettlementItemsboolean

If set to true, includes related settlement items for each invoice in a additional property SettlementItems (which may be empty). If set to false or not specified, the additional property is omitted.

Response

200

Paidboolean

Marketsstring[]

InvoiceNumberstring

InvoiceDatestring

DueDatestring

CreditBankAccountstring

DebitBankAccountstring

InvoiceAccountstring

Currencystring

TotalAmountnumber

HasPdfDownloadboolean

HasXmlDownloadboolean

SettlementTransactionIdsinteger[]

FromDeliveryDatestring

ToDeliveryDatestring

Countrystring

ReferenceNumberstring

LegalEntityCodestring

LegalEntityNamestring

OrganizationNumberstring

Example response

[
  {
    "Paid": true,
    "Markets": [
      "N2EXDA"
    ],
    "InvoiceNumber": "3469913",
    "InvoiceDate": "2023-04-03T07:11:11.633Z",
    "DueDate": "2023-04-03T00:00:00Z",
    "CreditBankAccount": "NO12332121",
    "DebitBankAccount": "FI321321123",
    "InvoiceAccount": "N00102-IA1",
    "Currency": "GBP",
    "TotalAmount": 2.61,
    "HasPdfDownload": true,
    "HasXmlDownload": true,
    "SettlementTransactionIds": [
      535974
    ],
    "FromDeliveryDate": "2023-01-01T07:11:11.634Z",
    "ToDeliveryDate": "2023-01-02T07:11:11.634Z",
    "Country": "Norway",
    "ReferenceNumber": "N-1335668",
    "LegalEntityCode": "N00102",
    "LegalEntityName": "DEMO S.A",
    "OrganizationNumber": "302648707"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.