Credit

Returns the credit limit history of an account

Returns the credit limit history of an account filtered by a date range

GEThttps://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit/history

Path parameters

accountId*string (uuid)

The account ID

Query parameters

Response

2004004014034XX5XX

Successful response

Body

application/json

afternullable string

The token of the last item in the response

totalCountstring (integer)

The total number of items in the entire filtered data set

Example: "1"

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit/history?startDate=2024-02-01&endDate=2024-05-01', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "after": "text",
  "totalCount": "1",
  "items": [
    {
      "creditLimitRequested": "10000.00",
      "newCreditLimit": "10000.00",
      "action": "INCREASE",
      "updatedAt": "2024-08-01T18:44:05Z"
    }
  ]
}

Set the credit limit of an account

Set the credit limit of an account to the amount specified

PUThttps://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit

Path parameters

accountId*string (uuid)

The account ID

Body

application/json

amount*string (number)

Example: "10000"

Response

2004004014034XX5XX

Successful response

Body

application/json

accountIdstring (uuid)

newCreditLimitstring (number)

Example: "10000"

Request

JavaScriptCurlPython

const response = await fetch('https://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": "10000"
    }),
});
const data = await response.json();

Response

200

{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "newCreditLimit": "10000"
}

Increase or Decrease Credit Limit

Applies an incremental change to the credit limit of an account

PATCHhttps://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit

Path parameters

accountId*string (uuid)

The account ID

Body

application/json

amountstring (number)

The amount to increase or decrease the credit limit by

Example: "10000"

actionenum

The action to either increase or decrease the credit limit by the amount provided.

Example: "INCREASE"

INCREASEDECREASE

Response

2004004014034XX5XX

Successful response

Body

application/json

accountIdstring (uuid)

newCreditLimitstring (number)

Example: "20000"

Request

JavaScriptCurlPython

const response = await fetch('https://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "increaseAmount": "10000"
    }),
});
const data = await response.json();

Response

200

{
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "newCreditLimit": "20000"
}