junifer_au_native_api

v1.62.0

Published

3 years ago

Junifer_Native_Web_API_provided_by_the_Gentrack_Cloud_Integration_Services_How_It_WorksFor_how_to_prepare_your_application_to_call_Junifer_Native_Web_API_please_refer_to__Read_me_first_https__portal_integration_gentrack_cloud_api_index_htmlsection_Read_me

Downloads

0High
0Medium
0Low

glennkentwell

junifer_au_native_api

JuniferAuNativeApi - JavaScript client for junifer_au_native_api Junifer Native Web API provided by the Gentrack Cloud Integration Services

How It Works

For how to prepare your application to call Junifer Native Web API, please refer to:

Sample of requesting contact details

The following is an example of calling get contact details API in UK region:

curl -X GET \\
    https://api-uk.integration.gentrack.cloud/v1/junifer/contacts/1010 \\
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6IjA2NDYxODczLTFlOWMtNGVkMy1iZWZkLTU3NGY5ZmEwYjExYyIsIm9yZ0lkIj
oiQzAwMDAiLCJ0b2tlbl91c2UiOiJhY2Nlc3MiLCJpYXQiOjE1MzA1ODkwODcsImV4cCI6MTUzMDU5MjY4NywiaXNzIjoiaHR0cHM6Ly9hcGkuZ2VudHJhY2suaW8vIn0.WUAFYWTTEAy
Q0Bt4YXu-mxCXd-Y9ehwdZcYvcGNnyLTZH_hiJjtXWWfsx69M606pvCP6lLMT7MfK-F3E4rLO6KAlGsuz4A_7oVWQf4QNeR178GnwgmqQRw5OnLxwPbPrRa9nODngwGq8dcWejhmEYU6i
w02bvYdQBHnnsc3Kpyzw7Wdv_3jnBS4TPYS20muQOgG6KxRp9hLJM7ERLoAbsULwqdPOV8eUJJhGrq1NDuH_lA83YRDZmCWEzw96tSm3hb7y88kXs-4OvamnO1m5wFPBx69VximlS4Ltr
3ztqU2s3fHoj0OJLIafge9JvTgvuB6noHfs1uSRaahvstGJAA'

The sample of response is as follows.

{
   \"id\": 1010,
   \"contactType\": \"Business\",
   \"title\": \"Mr\",
   \"forename\": \"Tony\",
   \"surname\": \"Soprano\",
   \"email\": \"[email protected]\",
   \"dateOfBirth\": \"1959-08-24\",
   \"phoneNumber1\": \"44626478370\",
   \"address\":{
     \"address1\": \"633 Stag Trail Road\",
     \"address2\": \"North Caldwell\",
     \"address3\": \"New Jersey\",
     \"postcode\": \"NE18 0PY\"
   },
   \"links\": {
     \"self\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/contacts/1010\",
     \"accounts\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/contacts/1010/accounts\"
   }
}

General Rules/Patterns

Navigation

A links section is returned in most requests.

This section contains how to access the entity itself and, more importantly, how to access items related to the entity.

For example take the following response:

{
  \"id\": 1,
  \"name\": \"Mr Joe Bloggs\",
  \"number\": \"00000001\",
  \"surname\": \"Bloggs\",
  \"links\": {
    \"self\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/customers/1\"
  },
  \"accounts\": [
    {
      \"id\": 7,
      \"name\": \"Invoice\",
      \"number\": \"00000001\",
      \"currency\": \"GBP\",
      \"fromDt\": \"2013-05-01\",
      \"createdDttm\": \"2013-05-08T13:36:34.000\",
      \"balance\": 0,
      \"billingAddress\": {
        \"address1\": \"11 Tuppy Street\"
      },
      \"links\": {
        \"self\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/accounts/7\",
        \"customer\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/customers/1\",
        \"bills\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/accounts/7/bills\",
        \"payments\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/accounts/7/payments\"
      }
    }
  ]
}

The self URL in the links section can be used to access the entities listed in the response. In the above example there are self fields for the customer itself, and the accounts under this customer. There are other links under the account.

For example the above example contains links for the following:

bills – List of Bills for the Account
payments – List of Payments for the Account
customer – Link back to the Account’s Customer

About IDs

The id in the API requests (JSON payload and URL) and responses identifies the resource within the API. It has no business meaning or purpose, therefore shouldn't be exposed to the end user in any way.

As the IDs of the resources aren't sequential or aligned with any other resource IDs, it is highly recommended using the links section from the responses to navigate to other related resources. Given the example above, the customer with ID 1 links to the account with ID 7. The links section will populate the correct IDs in the URLs so none of the assumptions about related resource IDs need to be made by the implementer.

Accessing accounts by account number

Throughout this API, anywhere an account is accessed by its id (i.e. the URL includes /accounts/:id), it can also be accessed by its account number by replacing /accounts/:id with accounts/accountNumber/:num.

For example: the Create Account Credit endpoint, available at /accounts/:id/accountCredits, can also be accessed at /accounts/accountNumber/:num/accountCredits.

Standard data types in JSON

The standard data types are as follows:

String – Quoted as per JSON standard
Number – Unquoted as per JSON standard
Decimal – Unquoted as per JSON standard
Date – In the standard ISO format "yyyy-MM-dd"
DateTime – In the standard ISO format "yyyy-MM-ddThh:mm:ss.SSS" (no time zone component)
Boolean – Unquoted 'true' and 'false' are the only valid values

Ordering of data

Response representations are not ordered unless specified on a specific resource. Therefore, clients should be implemented to use the name of fields/objects as the key for accessing data.

For example in JSON objects are comprised of key/value pairs and clients should be implemented to search on the ‘key’ value rather than looking for the nth key/value pair in the object.

Changes of data

Response representations may change without warning in the following ways.

Additional key/value pairs may be added to an existing object
Additional sub-objects may be added to an existing object

These changes are considered non-breaking.

Therefore, clients should be implemented to consume only the data they need and ignore any other information.

Versioning

The API is usually changed in each release of Junifer. Navigate to different versions by clicking the dropdown menu in the top right of this web page.

Pagination

Some REST APIs that provide a list of results support pagination.

Pagination allows API users to query potential large data sets but only receive a sub-set of the results on the initial query. Subsequent queries can use the response of a prior query to retrieve the next or previous set of results.

Pagination functionality and behaviour will be documented on each API that requires it.

Pagination on existing APIs

Existing APIs may have pagination support added. In the future this pagination will become mandatory.

In order to facilitate API users planning and executing upgrades against the existing APIs, pagination is optional during a transition period. API users can enable pagination on these APIs by specifying the pagination query parameter. This parameter only needs to be present, the value is not required or checked. If this query parameter is specified, then pagination will be enabled. Otherwise, the existing non-paginated functionality, that returns all results, will be used.

API users must plan and execute upgrades to their existing applications to use the pagination support during the transition period. At the end of the transition period pagination will become mandatory on these APIs.

For new APIs that support pagination, it will be mandatory with the initial release of the API.

Ordering

The ordering that the API provides will be documented for each API.

An ordering is always required to ensure moving between pages is consistent.

Some APIs may define an ordering on a value or values in the response where appropriate. For example results may be ordered by a date/time property of the results.

Other APIs may not define an explicit ordering but will guarantee the order is consistent for multiple API calls.

Limiting results of each page

The desiredResults query parameter can be used to specify the maximum number of results that may be returned.

The APIs treat this as a hint so API callers should expect to sometimes receive a different number of results. APIs will endeavour to ensure no more than desiredResults are returned but for small values of desiredResults (less than 10) this may not be possible. This is due to how pages of data are structured inside the product. The API will prefer to return some data rather than no data where it is not possible to return less than desiredResults

If desiredResults is not specified the default maximum value for the API will be used. Unless documented differently, this value is 100.

If desiredResults is specified higher than the default maximum for the API a 400 error response will be received.

Cursors

The pagination provided by the APIs is cursor-based.

In the JSON response additional metadata will be provided when pagination is present.

after cursor points to the start of the results that have been returned
before cursor points to the end of the results that have been returned

These cursors can be used to make subsequent API calls. The API URL should be unchanged except for setting the before or after query parameter. If both parameters are specified, then an error 400 response will be received.

Cursor tokens must only be used for pagination purposes. API users should not infer any business meaning or logic from cursor representations. These representations may change without warning when Junifer is upgraded.

When scrolling forward the after cursor will be absent from the response when there are no more results after the current set.

When scrolling backwards the before cursor will be absent from the response when there are no more results before the current set.

In addition, a paginated response will include a next and previous URLs for convenience.

Best practices

The following best practices must be adhered to by users of the pagination APIs:

Don't store cursors or next and previous URLs for long. Cursors can quickly become invalid if items are added or deleted to the data set
If an invalid cursor is used, then a 404 response will be returned in this situation. API users should design a policy to handle this situation
API users should handle empty data sets. In limited cases a pagination query using a previously valid cursor may return no results

Example

This example is illustrative only.

A small desiredResults parameter has been used to make the example concise. API users should generally choose larger values, subject to the maximum value.

The following API call would retrieve the first set of results.

Request

https://api-uk.integration.gentrack.cloud/v1/junifer/uk/meterPoints/1/payg/balances?desiredResults=3 \\
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9....aahvstGJAA'

Response

{
  \"results\": [
    {
      \"snapshotDateTime\": \"2019-04-20T00:00:00.000\",
      \"creditBalance\": 109,
      \"emergencyCreditBalance\": 0,
      \"accumulatedDebtRegister\": 0,
      \"timeDebtRegister1\": 0,
      \"timeDebtRegister2\": 0,
      \"paymentDebtRegister\": 0
    },
    {
      \"snapshotDateTime\": \"2019-04-19T00:00:00.000\",
      \"creditBalance\": 108,
      \"emergencyCreditBalance\": 0,
      \"accumulatedDebtRegister\": 0,
      \"timeDebtRegister1\": 0,
      \"timeDebtRegister2\": 0,
      \"paymentDebtRegister\": 0
    },
    {
      \"snapshotDateTime\": \"2019-04-18T00:00:00.000\",
      \"creditBalance\": 107,
      \"emergencyCreditBalance\": 0,
      \"accumulatedDebtRegister\": 0,
      \"timeDebtRegister1\": 0,
      \"timeDebtRegister2\": 0,
      \"paymentDebtRegister\": 0
    }
  ],
  \"pagination\": {
    \"cursors\": {
      \"after\": \"107\"
    },
    \"next\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/uk/meterPoints/1/payg/balances?pagination=&desiredResults=3&after=107\"
  }
}

The results section contains the payload of the API.

The pagination section contains details needed to retrieve additional results.

API users can choose to use the next URL directly or use the after cursor token to construct the URL themselves.

The API call to query the next set of results would be

Request

https://api-uk.integration.gentrack.cloud/v1/junifer/uk/meterPoints/1/payg/balances?pagination=&desiredResults=3&after=107 \\
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9....aahvstGJAA'

Response

{
  \"results\": [
    {
      \"snapshotDateTime\": \"2019-04-17T00:00:00.000\",
      \"creditBalance\": 106,
      \"emergencyCreditBalance\": 0,
      \"accumulatedDebtRegister\": 0,
      \"timeDebtRegister1\": 0,
      \"timeDebtRegister2\": 0,
      \"paymentDebtRegister\": 0
    },
    {
      \"snapshotDateTime\": \"2019-04-16T00:00:00.000\",
      \"creditBalance\": 105,
      \"emergencyCreditBalance\": 0,
      \"accumulatedDebtRegister\": 0,
      \"timeDebtRegister1\": 0,
      \"timeDebtRegister2\": 0,
      \"paymentDebtRegister\": 0
    },
    {
      \"snapshotDateTime\": \"2019-04-15T00:00:00.000\",
      \"creditBalance\": 104,
      \"emergencyCreditBalance\": 0,
      \"accumulatedDebtRegister\": 0,
      \"timeDebtRegister1\": 0,
      \"timeDebtRegister2\": 0,
      \"paymentDebtRegister\": 0
    }
  ],
  \"pagination\": {
    \"cursors\": {
      \"before\": \"106\",
      \"after\": \"104\"
    },
    \"previous\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/uk/meterPoints/1/payg/balances?pagination=&before=106&desiredResults=3\",
    \"next\": \"https://api-uk.integration.gentrack.cloud/v1/junifer/uk/meterPoints/1/payg/balances?pagination=&desiredResults=3&after=104\"
  }
}

This time the response contains both before and after tokens and previous and next URLs. The before token or previous link can be used to navigate backwards in the results.

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.61.1
Package version: 1.61.1
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install junifer_au_native_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your junifer_au_native_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var JuniferAuNativeApi = require('junifer_au_native_api');

var defaultClient = JuniferAuNativeApi.ApiClient.instance;
// Configure API key authorization: tokenAuth
var tokenAuth = defaultClient.authentications['tokenAuth'];
tokenAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//tokenAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new JuniferAuNativeApi.AccountCreditsApi()
var id = 3.4; // {Number} Account credit ID number
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.juniferAccountCreditsIdDelete(id, callback);

Documentation for API Endpoints

All URIs are relative to https://api-au.integration.gentrack.cloud/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- JuniferAuNativeApi.AccountCreditsApi | juniferAccountCreditsIdDelete | DELETE /junifer/accountCredits/{id} | Cancel account credit JuniferAuNativeApi.AccountCreditsApi | juniferAccountCreditsIdGet | GET /junifer/accountCredits/{id} | Get Account Credit JuniferAuNativeApi.AccountDebitsApi | juniferAccountDebitsIdDelete | DELETE /junifer/accountDebits/{id} | Cancel account debit JuniferAuNativeApi.AccountDebitsApi | juniferAccountDebitsIdGet | GET /junifer/accountDebits/{id} | Get Account Debit JuniferAuNativeApi.AccountsApi | juniferAccountsAccountNumberNumGet | GET /junifer/accounts/accountNumber/{num} | Get account by account number JuniferAuNativeApi.AccountsApi | juniferAccountsGet | GET /junifer/accounts | Account lookup JuniferAuNativeApi.AccountsApi | juniferAccountsIdAccountCreditsGet | GET /junifer/accounts/{id}/accountCredits | Get account credits JuniferAuNativeApi.AccountsApi | juniferAccountsIdAccountCreditsPost | POST /junifer/accounts/{id}/accountCredits | Create account credit JuniferAuNativeApi.AccountsApi | juniferAccountsIdAccountDebitsGet | GET /junifer/accounts/{id}/accountDebits | Get account debits JuniferAuNativeApi.AccountsApi | juniferAccountsIdAccountDebitsPost | POST /junifer/accounts/{id}/accountDebits | Create account debit JuniferAuNativeApi.AccountsApi | juniferAccountsIdAccountReviewPeriodsGet | GET /junifer/accounts/{id}/accountReviewPeriods | Get account's review periods JuniferAuNativeApi.AccountsApi | juniferAccountsIdAccountReviewPeriodsPost | POST /junifer/accounts/{id}/accountReviewPeriods | Create account review period JuniferAuNativeApi.AccountsApi | juniferAccountsIdAgreementsGet | GET /junifer/accounts/{id}/agreements | Get account's agreements JuniferAuNativeApi.AccountsApi | juniferAccountsIdAllPayReferenceGet | GET /junifer/accounts/{id}/allPayReference | Get account's AllPay Reference Number JuniferAuNativeApi.AccountsApi | juniferAccountsIdBillRequestsGet | GET /junifer/accounts/{id}/billRequests | Get account's bill requests JuniferAuNativeApi.AccountsApi | juniferAccountsIdBillsGet | GET /junifer/accounts/{id}/bills | Get account's bills JuniferAuNativeApi.AccountsApi | juniferAccountsIdCancelAccountReviewPeriodDelete | DELETE /junifer/accounts/{id}/cancelAccountReviewPeriod | Cancel account review period JuniferAuNativeApi.AccountsApi | juniferAccountsIdChangeAccountCustomerPut | PUT /junifer/accounts/{id}/changeAccountCustomer | Change the customer linked to an account JuniferAuNativeApi.AccountsApi | juniferAccountsIdCommercialProductDetailsGet | GET /junifer/accounts/{id}/commercial/productDetails | Get account's product details for commercial customer JuniferAuNativeApi.AccountsApi | juniferAccountsIdCommunicationsGet | GET /junifer/accounts/{id}/communications | Get account's communications JuniferAuNativeApi.AccountsApi | juniferAccountsIdContactsContactIdPut | PUT /junifer/accounts/{id}/contacts/{contactId} | Update account's contact details JuniferAuNativeApi.AccountsApi | juniferAccountsIdContactsGet | GET /junifer/accounts/{id}/contacts | Contacts JuniferAuNativeApi.AccountsApi | juniferAccountsIdCreditsGet | GET /junifer/accounts/{id}/credits | Get account's credits JuniferAuNativeApi.AccountsApi | juniferAccountsIdEnrolMeterPointsPost | POST /junifer/accounts/{id}/enrolMeterPoints | Enrol additional Meter Points to existing account/site JuniferAuNativeApi.AccountsApi | juniferAccountsIdGet | GET /junifer/accounts/{id} | Get account JuniferAuNativeApi.AccountsApi | juniferAccountsIdHotBillPost | POST /junifer/accounts/{id}/hotBill | Hot bill JuniferAuNativeApi.AccountsApi | juniferAccountsIdNotePost | POST /junifer/accounts/{id}/note | Create account note JuniferAuNativeApi.AccountsApi | juniferAccountsIdPaymentMethodsGet | GET /junifer/accounts/{id}/paymentMethods | Get account's payment methods JuniferAuNativeApi.AccountsApi | juniferAccountsIdPaymentPlansGet | GET /junifer/accounts/{id}/paymentPlans | Get account's payment plans JuniferAuNativeApi.AccountsApi | juniferAccountsIdPaymentPost | POST /junifer/accounts/{id}/payment | Create Payment Transaction JuniferAuNativeApi.AccountsApi | juniferAccountsIdPaymentSchedulePeriodsGet | GET /junifer/accounts/{id}/paymentSchedulePeriods | Get account's payment schedule periods JuniferAuNativeApi.AccountsApi | juniferAccountsIdPaymentSchedulesSuggestedPaymentAmountGet | GET /junifer/accounts/{id}/paymentSchedules/suggestedPaymentAmount | Get account's suggested payment amount JuniferAuNativeApi.AccountsApi | juniferAccountsIdPaymentsGet | GET /junifer/accounts/{id}/payments | Get account's payments JuniferAuNativeApi.AccountsApi | juniferAccountsIdPrimaryContactPut | PUT /junifer/accounts/{id}/primaryContact | Update Accounts's primary contact details. JuniferAuNativeApi.AccountsApi | juniferAccountsIdProductDetailsGet | GET /junifer/accounts/{id}/productDetails | Get account's product details JuniferAuNativeApi.AccountsApi | juniferAccountsIdPropertysGet | GET /junifer/accounts/{id}/propertys | Get account's properties JuniferAuNativeApi.AccountsApi | juniferAccountsIdRenewalPost | POST /junifer/accounts/{id}/renewal | Renew account JuniferAuNativeApi.AccountsApi | juniferAccountsIdRepaymentsPost | POST /junifer/accounts/{id}/repayments | Create account repayment JuniferAuNativeApi.AccountsApi | juniferAccountsIdTariffInformationGet | GET /junifer/accounts/{id}/tariffInformation | Get account's tariff Information JuniferAuNativeApi.AccountsApi | juniferAccountsIdTicketsGet | GET /junifer/accounts/{id}/tickets | Get account's tickets JuniferAuNativeApi.AccountsApi | juniferAccountsIdTicketsPost | POST /junifer/accounts/{id}/tickets | Create account ticket JuniferAuNativeApi.AccountsApi | juniferAccountsIdTransactionsGet | GET /junifer/accounts/{id}/transactions | Get account's transactions JuniferAuNativeApi.AccountsAustraliaApi | juniferAuAccountsIdDiscountsGet | GET /junifer/au/accounts/{id}/discounts | Get discounts linked to the account specified by the ID JuniferAuNativeApi.AccountsAustraliaApi | juniferAuAccountsIdDiscountsPost | POST /junifer/au/accounts/{id}/discounts | Links a discount to the account specified by the ID JuniferAuNativeApi.AccountsAustraliaApi | juniferAuAccountsIdRenewalPost | POST /junifer/au/accounts/{id}/renewal | Renew account with one or more new agreements JuniferAuNativeApi.AlertsApi | juniferAlertsIdGet | GET /junifer/alerts/{id} | Get alert JuniferAuNativeApi.BillPeriodsApi | juniferBillPeriodsIdGet | GET /junifer/billPeriods/{id} | Get Bill Period JuniferAuNativeApi.BillRequestsApi | juniferBillRequestsIdGet | GET /junifer/billRequests/{id} | Get bill request JuniferAuNativeApi.BillRequestsApi | juniferBillRequestsIdRestartFailedPost | POST /junifer/billRequests/{id}/restartFailed | Restart failed bill request JuniferAuNativeApi.BillingEntitiesApi | juniferBillingEntitiesIdGet | GET /junifer/billingEntities/{id} | Get billing entity JuniferAuNativeApi.BillsApi | juniferBillEmailsIdGet | GET /junifer/billEmails/{id} | Get bill email JuniferAuNativeApi.BillsApi | juniferBillFilesIdGet | GET /junifer/billFiles/{id} | Get bill file JuniferAuNativeApi.BillsApi | juniferBillFilesIdImageGet | GET /junifer/billFiles/{id}/image | Get bill file image JuniferAuNativeApi.BillsApi | juniferBillsIdAcceptDraftPost | POST /junifer/bills/{id}/acceptDraft | Accept Draft bill JuniferAuNativeApi.BillsApi | juniferBillsIdBillBreakdownLinesGet | GET /junifer/bills/{id}/billBreakdownLines | Get bill's breakdown lines JuniferAuNativeApi.BillsApi | juniferBillsIdGet | GET /junifer/bills/{id} | Get bill JuniferAuNativeApi.BillsApi | juniferBillsIdReversionPost | POST /junifer/bills/{id}/reversion | Reversion bill JuniferAuNativeApi.CommunicationsApi | juniferCommunicationsEmailPost | POST /junifer/communications/email | Send email JuniferAuNativeApi.CommunicationsApi | juniferCommunicationsEmailsIdGet | GET /junifer/communicationsEmails/{id} | Get communication email JuniferAuNativeApi.CommunicationsApi | juniferCommunicationsFilesIdGet | GET /junifer/communicationsFiles/{id} | Get communication file JuniferAuNativeApi.CommunicationsApi | juniferCommunicationsFilesIdImageGet | GET /junifer/communicationsFiles/{id}/image | Get communication file image JuniferAuNativeApi.CommunicationsApi | juniferCommunicationsIdGet | GET /junifer/communications/{id} | Get Communication JuniferAuNativeApi.ConcessionsAustraliaApi | juniferAuConcessionsCreateConcessionPost | POST /junifer/au/concessions/createConcession | Create concession JuniferAuNativeApi.ContactsApi | juniferContactsIdAccountsGet | GET /junifer/contacts/{id}/accounts | Get accounts JuniferAuNativeApi.ContactsApi | juniferContactsIdGet | GET /junifer/contacts/{id} | Get contact JuniferAuNativeApi.ContactsApi | juniferContactsIdMarketingPreferencesGet | GET /junifer/contacts/{id}/marketingPreferences | Get a contact's marketing preferences JuniferAuNativeApi.ContactsApi | juniferContactsIdMarketingPreferencesPut | PUT /junifer/contacts/{id}/marketingPreferences | Update a contact's marketing preferences JuniferAuNativeApi.CreditsApi | juniferCreditFilesIdGet | GET /junifer/creditFiles/{id} | Get credit file JuniferAuNativeApi.CreditsApi | juniferCreditFilesIdImageGet | GET /junifer/creditFiles/{id}/image | Get credit file image JuniferAuNativeApi.CreditsApi | juniferCreditsIdCreditBreakdownLinesGet | GET /junifer/credits/{id}/creditBreakdownLines | Get credit's breakdown lines JuniferAuNativeApi.CreditsApi | juniferCreditsIdGet | GET /junifer/credits/{id} | Get Credit JuniferAuNativeApi.CustomerPaymentsApi | juniferAuBpointDirectDebitsIdDelete | DELETE /junifer/au/bpointDirectDebits/{id} | Cancel BPOINT Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferAuBpointDirectDebitsIdGet | GET /junifer/au/bpointDirectDebits/{id} | Existing BPOINT Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferAuBpointDirectDebitsPost | POST /junifer/au/bpointDirectDebits | New BPOINT Direct Debit JuniferAuNativeApi.CustomerPaymentsApi | juniferAuPayPalDirectDebitsIdDelete | DELETE /junifer/au/payPalDirectDebits/{id} | Cancel PayPal Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferAuPayPalDirectDebitsIdGet | GET /junifer/au/payPalDirectDebits/{id} | Existing PayPal Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferAuPayPalDirectDebitsPost | POST /junifer/au/payPalDirectDebits | New PayPal Direct Debit JuniferAuNativeApi.CustomerPaymentsApi | juniferAuWestpacDirectDebitsIdDelete | DELETE /junifer/au/westpacDirectDebits/{id} | Cancel Westpac Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferAuWestpacDirectDebitsIdGet | GET /junifer/au/westpacDirectDebits/{id} | Existing Westpac Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferAuWestpacDirectDebitsPost | POST /junifer/au/westpacDirectDebits | New Westpac Direct Debit JuniferAuNativeApi.CustomerPaymentsApi | juniferSepaDirectDebitsIdDelete | DELETE /junifer/sepaDirectDebits/{id} | Cancel SEPA Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferSepaDirectDebitsIdGet | GET /junifer/sepaDirectDebits/{id} | Existing SEPA Direct Debit Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferSepaDirectDebitsIdPut | PUT /junifer/sepaDirectDebits/{id} | Update SEPA Direct Debit Mandate JuniferAuNativeApi.CustomerPaymentsApi | juniferSepaDirectDebitsPost | POST /junifer/sepaDirectDebits | New SEPA Direct Debit Mandate JuniferAuNativeApi.CustomerPaymentsApi | juniferStripePaymentCardsIdDelete | DELETE /junifer/stripePaymentCards/{id} | Cancel Stripe Payment Card JuniferAuNativeApi.CustomerPaymentsApi | juniferStripePaymentCardsIdGet | GET /junifer/stripePaymentCards/{id} | Existing Stripe Payment Card Instruction JuniferAuNativeApi.CustomerPaymentsApi | juniferStripePaymentCardsIdPaymentsPost | POST /junifer/stripePaymentCards/{id}/payments | Create Stripe Card Payment Collection JuniferAuNativeApi.CustomerPaymentsApi | juniferStripePaymentCardsPost | POST /junifer/stripePaymentCards | Store Stripe Payment Card JuniferAuNativeApi.CustomersApi | juniferCustomersEnrolCustomerPost | POST /junifer/customers/enrolCustomer | Enrol customer JuniferAuNativeApi.CustomersApi | juniferCustomersGet | GET /junifer/customers | Customer lookup JuniferAuNativeApi.CustomersApi | juniferCustomersIdAccountsGet | GET /junifer/customers/{id}/accounts | Get customer's accounts JuniferAuNativeApi.CustomersApi | juniferCustomersIdBillingEntitiesGet | GET /junifer/customers/{id}/billingEntities | Get customer's billing entities JuniferAuNativeApi.CustomersApi | juniferCustomersIdConsentsGet | GET /junifer/customers/{id}/consents | Get customer's consents JuniferAuNativeApi.CustomersApi | juniferCustomersIdConsentsPut | PUT /junifer/customers/{id}/consents | Update customer's consents JuniferAuNativeApi.CustomersApi | juniferCustomersIdContactsContactIdPut | PUT /junifer/customers/{id}/contacts/{contactId} | Update customer's contact details JuniferAuNativeApi.CustomersApi | juniferCustomersIdContactsGet | GET /junifer/customers/{id}/contacts | Contacts JuniferAuNativeApi.CustomersApi | juniferCustomersIdCreateProspectPut | PUT /junifer/customers/{id}/createProspect | Create Prospect JuniferAuNativeApi.CustomersApi | juniferCustomersIdEnrolAdditionalAccountPost | POST /junifer/customers/{id}/enrolAdditionalAccount | Enrol a new account to an existing customer JuniferAuNativeApi.CustomersApi | juniferCustomersIdGet | GET /junifer/customers/{id} | Get customer JuniferAuNativeApi.CustomersApi | juniferCustomersIdPrimaryContactPut | PUT /junifer/customers/{id}/primaryContact | Update customer's primary contact details JuniferAuNativeApi.CustomersApi | juniferCustomersIdProspectsGet | GET /junifer/customers/{id}/prospects | Get customer's Prospects JuniferAuNativeApi.CustomersApi | juniferCustomersIdPut | PUT /junifer/customers/{id} | Update customer JuniferAuNativeApi.CustomersApi | juniferCustomersIdUpdateBillingAddressPut | PUT /junifer/customers/{id}/updateBillingAddress | Update customer's Billing Address. JuniferAuNativeApi.CustomersAustraliaApi | juniferAuCustomersEnrolBusinessCustomerPost | POST /junifer/au/customers/enrolBusinessCustomer | Enrol business customer JuniferAuNativeApi.CustomersAustraliaApi | juniferAuCustomersEnrolCustomerPost | POST /junifer/au/customers/enrolCustomer | Enrol customer JuniferAuNativeApi.CustomersAustraliaApi | juniferAuCustomersLifeSupportPost | POST /junifer/au/customers/lifeSupport | Add life support and sensitive load details JuniferAuNativeApi.CustomersAustraliaApi | juniferAuCustomersSiteAccessPost | POST /junifer/au/customers/siteAccess | Add site access and hazard details JuniferAuNativeApi.FinancialsApi | juniferActiveSeasonalDefinitionGet | GET /junifer/activeSeasonalDefinition | Get active seasonal definition JuniferAuNativeApi.FinancialsApi | juniferPaymentMethodsIdGet | GET /junifer/paymentMethods/{id} | Get payment method JuniferAuNativeApi.FinancialsApi | juniferPaymentPlansIdGet | GET /junifer/paymentPlans/{id} | Get payment plan JuniferAuNativeApi.FinancialsApi | juniferPaymentRequestsIdGet | GET /junifer/paymentRequests/{id} | Get payment request JuniferAuNativeApi.FinancialsApi | juniferPaymentSchedulePeriodsCalculateNextPaymentDateGet | GET /junifer/paymentSchedulePeriods/calculateNextPaymentDate | Calculate next payment schedule collection date JuniferAuNativeApi.FinancialsApi | juniferPaymentSchedulePeriodsIdGet | GET /junifer/paymentSchedulePeriods/{id} | Get payment schedule period JuniferAuNativeApi.FinancialsApi | juniferPaymentSchedulePeriodsIdPut | PUT /junifer/paymentSchedulePeriods/{id} | Stop payment schedule period JuniferAuNativeApi.FinancialsApi | juniferPaymentSchedulePeriodsPaymentScheduleItemsGet | GET /junifer/paymentSchedulePeriods/paymentScheduleItems | Get account's payment schedule items JuniferAuNativeApi.FinancialsApi | juniferPaymentSchedulePeriodsPost | POST /junifer/paymentSchedulePeriods | Create new payment schedule period JuniferAuNativeApi.FinancialsApi | juniferPaymentsIdGet | GET /junifer/payments/{id} | Get payment JuniferAuNativeApi.MarketingCampaignSourcesApi | juniferMarketingCampaignSourcesGet | GET /junifer/marketingCampaignSources | List Marketing Campaign Sources JuniferAuNativeApi.MeterpointsAustraliaApi | juniferAuMeterPointsGet | GET /junifer/au/meterPoints | MeterPoint lookup JuniferAuNativeApi.MeterpointsAustraliaApi | juniferAuMeterPointsIdMeterStructureGet | GET /junifer/au/meterPoints/{id}/meterStructure | Get meterpoint structure JuniferAuNativeApi.MeterpointsAustraliaApi | juniferAuMeterPointsIdReadingsGet | GET /junifer/au/meterPoints/{id}/readings | Get meter readings JuniferAuNativeApi.MeterpointsAustraliaApi | juniferAuMeterPointsIdReadingsPost | POST /junifer/au/meterPoints/{id}/readings | Submit meter readings JuniferAuNativeApi.MeterpointsAustraliaApi | juniferAuMeterPointsMeterStructureGet | GET /junifer/au/meterPoints/meterStructure | Get meterpoint structure JuniferAuNativeApi.NmisApi | juniferAuNmisStandingDataForNMIGet | GET /junifer/au/nmis/standingDataForNMI | Get NMIs including standing data JuniferAuNativeApi.OffersApi | juniferOffersIdGet | GET /junifer/offers/{id} | Get Offer JuniferAuNativeApi.OffersApi | juniferOffersIdQuotesGet | GET /junifer/offers/{id}/quotes | Get quotes JuniferAuNativeApi.PaymentPlansApi | juniferPaymentPlansIdPaymentPlanPaymentsGet | GET /junifer/paymentPlans/{id}/paymentPlanPayments | Get paymentPlan's payments JuniferAuNativeApi.ProductsApi | juniferAuProductsTariffsForNMIGet | GET /junifer/au/products/tariffsForNMI | Get products for nmi JuniferAuNativeApi.PropertiesApi | juniferPropertysIdGet | GET /junifer/propertys/{id} | Get property JuniferAuNativeApi.PropertiesApi | juniferPropertysIdMeterPointsGet | GET /junifer/propertys/{id}/meterPoints | Get meter points JuniferAuNativeApi.PropertiesApi | juniferPropertysPost | POST /junifer/propertys | JuniferAuNativeApi.ProspectsApi | juniferBrokerLinkagesIdGet | GET /junifer/brokerLinkages/{id} | Get Broker Linkage JuniferAuNativeApi.ProspectsApi | juniferBrokersGet | GET /junifer/brokers | Lookup broker JuniferAuNativeApi.ProspectsApi | juniferBrokersIdBrokerLinkagesGet | GET /junifer/brokers/{id}/brokerLinkages | Get BrokerLinkages for Broker JuniferAuNativeApi.ProspectsApi | juniferBrokersIdGet | GET /junifer/brokers/{id} | Get Broker JuniferAuNativeApi.ProspectsApi | juniferProspectsIdAddPropertiesPost | POST /junifer/prospects/{id}/add_properties | Add Properties JuniferAuNativeApi.ProspectsApi | juniferProspectsIdGet | GET /junifer/prospects/{id} | Get prospect JuniferAuNativeApi.ProspectsApi | juniferProspectsIdOffersGet | GET /junifer/prospects/{id}/offers | Get prospect offers JuniferAuNativeApi.ProspectsApi | juniferProspectsIdPropertysGet | GET /junifer/prospects/{id}/propertys | Get prospect's properties JuniferAuNativeApi.ProspectsApi | juniferProspectsPost | POST /junifer/prospects | Create Prospect JuniferAuNativeApi.QuoteFilesApi | juniferQuoteFilesIdGet | GET /junifer/quoteFiles/{id} | Get quote file JuniferAuNativeApi.QuoteFilesApi | juniferQuoteFilesIdImageGet | GET /junifer/quoteFiles/{id}/image | Get quote file image JuniferAuNativeApi.QuotesApi | juniferQuotesIdAcceptQuotePost | POST /junifer/quotes/{id}/acceptQuote | JuniferAuNativeApi.QuotesApi | juniferQuotesIdGet | GET /junifer/quotes/{id} | Get quote JuniferAuNativeApi.TicketsApi | juniferTicketsIdCancelTicketPost | POST /junifer/tickets/{id}/cancelTicket | Cancel Ticket JuniferAuNativeApi.TicketsApi | juniferTicketsIdGet | GET /junifer/tickets/{id} | Get ticket JuniferAuNativeApi.TicketsApi | juniferTicketsIdPut | PUT /junifer/tickets/{id} | Update Ticket

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

junifer_au_native_api

How It Works

Sample of requesting contact details

General Rules/Patterns

Navigation

About IDs

Accessing accounts by account number

Standard data types in JSON

Ordering of data

Changes of data

Versioning

Pagination

Pagination on existing APIs

Ordering

Limiting results of each page

Cursors

Best practices

Example

Request

Response

Request

Response

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models