EnergyLink data contract | PatchOps Knowledge

Provenance

PublisherEnergyLink

API basehttps://api.energylink.com/

Freshness & coverage

FreshnessFreshness not declared

GeographicNot declared

TemporalNot declared

AuthenticationCredentials required (Basic auth)

Methods (34)

inquiryCloseAchs

unknown

Close ACH inquiry for an operator

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

inquiryCloseCoas

unknown

Close COA inquiry for an operator

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

inquiryGetAchExport

read

Returns the unprocessed owner inquiries for changes to their electronic payment information.

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "isTesting": {
      "type": "boolean"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

inquiryGetCoaExport

read

Returns the unprocessed owner inquiries for changes to their address information.

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "isTesting": {
      "type": "boolean"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

inquiryInquiryOwnerInfoCsv

read

Upload an Owner Info CSV file (used for Inquiries Plus).

Entitiesowner information

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "fileName": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpApproveInvoices

unknown

Approve statements in a set of invoices

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpApproveStatement

unknown

Approve statement details, passing any details that must remain unapproved.

Required paramsid

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

nonOpAssignVoucherReferences

unknown

Assign voucher references to invoices

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpCreateAfeXrefs

write

Create new Afe cross-references

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpCreateCcXrefs

write

Create new Cost Center cross references

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpInvoice

unknown

Return invoice details at the requested summarization level.

Required paramsidsummarization

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "summarization": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "summarization"
  ]
}

nonOpInvoiceSearch

read

Retrieve all invoices given specific conditions

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpQueueVoucher

unknown

Queue a voucher to be run at end of day

Required paramsid

Entitiesvoucher

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

nonOpRevenue

unknown

Return check details at the requested summarization level.

Required paramsidsummarization

Entitiesrevenue

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "summarization": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "summarization"
  ]
}

nonOpRevenueSearch

read

Retrieve all checks given specific conditions

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpRoyalty

unknown

Return royalty details at the requested summarization level.

Required paramsidsummarization

Entitiesroyalty

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "summarization": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id",
    "summarization"
  ]
}

nonOpRoyaltySearch

read

Retrieve all royalties given specific conditions

Entitiesproduction, ownership

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpUpdateAfeXrefs

write

Update Afe cross references

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpUpdateCcXrefs

write

Update Cost Center cross references

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

nonOpUpdateStatementDisputes

write

Updates a statement dispute

Required paramsid

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

nonOpValidateInvoice

read

Validate a specific invoice

Required paramsid

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

nonOpValidateVoucher

read

Validate a specific voucher

Required paramsid

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

voucherGetInvoiceVouchersForDownload

read

Returns all invoice vouchers of a specific type

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "invoiceType": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

voucherGetPaymentVouchersForDownload

read

Returns all payment vouchers

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

voucherGetVoucherFile

read

Returns a specific voucher

Required paramsid

Entitiesinvoice, document

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

voucherGetVoucherInfo

read

Return specific voucher information for given voucher id.

Required paramsid

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

voucherGetVoucherReports

read

Returns all PDF reports for a specific specific voucher id

Required paramsid

Entitiesinvoice, document

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "id": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "id"
  ]
}

voucherMarkVoucherAsDownloaded

unknown

Marks the specified voucher as downloaded (from an FTP client perspective...deleted)

Required paramsvoucherId

Entitiesinvoice

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "voucherId": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "voucherId"
  ]
}

arGetManagementReportOrgSummary

read

Generate management Report Org Summary Report

Entitiesdocument

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "isTesting": {
      "type": "boolean"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

processGetProcessFile

read

Get the process file of the process ID provided.

Required paramsprocessId

Entitiesdocument

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "processId": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "processId"
  ]
}

processGetProcessStatus

read

Get the status of the process ID provided.

Required paramsprocessId

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "processId": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false,
  "required": [
    "processId"
  ]
}

reportNonopQueueOpenDisputesReport

unknown

Queue the non-operated open dispute reports using the parameter passed in the request body.

Entitiesreport

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

reportOpQueueOpenDisputesReport

unknown

Queue the operated open dispute reports using the parameter passed in the request body.

Entitiesreport

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "body": {},
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}

queryEnergyLink

read

Generic EnergyLink API request helper for tenant-specific or undocumented endpoints.

Required paramsendpoint

Entitiesrecord

Input schema

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    },
    "endpoint": {
      "type": "string"
    },
    "method": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "POST"
          ]
        },
        {
          "type": "string",
          "enum": [
            "DELETE"
          ]
        },
        {
          "type": "string",
          "enum": [
            "PATCH"
          ]
        },
        {
          "type": "string",
          "enum": [
            "GET"
          ]
        },
        {
          "type": "string",
          "enum": [
            "PUT"
          ]
        }
      ]
    },
    "query": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "body": {},
    "expectBinary": {
      "type": "boolean"
    }
  },
  "additionalProperties": false,
  "required": [
    "endpoint"
  ]
}