Credit | Aquanow CAMS v1.0 (Updated)

Aquanow CAMS v1.0 (Updated)

Returns the credit limit history of an account

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

get

/v1/accounts/{accountId}/credit-limit/history

Authorizations

Path parameters

accountIdstring · uuidrequired

The account ID

Query parameters

startDatestring · daterequired

The first date to include in the credit limit history

Example: 2024-02-01

endDatestring · daterequired

The last date to include in the credit limit history

Example: 2024-05-01

afterstring

When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted.

limitstring · integer

When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit/history?startDate=2024-02-01&endDate=2024-05-01' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

4XX

5XX

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

Successful response

Set the credit limit of an account

Set the credit limit of an account to the amount specified

put

/v1/accounts/{accountId}/credit-limit

Authorizations

Path parameters

accountIdstring · uuidrequired

The account ID

Body

amountstring · numberrequired

Example: 10000

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": "10000"
  }'

200

400

401

403

4XX

5XX

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

Successful response

Increase or Decrease Credit Limit

Applies an incremental change to the credit limit of an account

patch

/v1/accounts/{accountId}/credit-limit

Authorizations

Path parameters

accountIdstring · uuidrequired

The account ID

Body

amountstring · number

The amount to increase or decrease the credit limit by

Example: 10000

actionstring · enum

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

Example: INCREASE

Options: INCREASE, DECREASE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://cams.aquanow.com/api/v1/accounts/{accountId}/credit-limit' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "increaseAmount": "10000"
  }'

200

400

401

403

4XX

5XX

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

Successful response