Credit

Returns the credit limit history of an account

get

https://cams.aquanow.com/apihttp://localhost:3001/apihttps://camsapi-dev.aquanow.com/apihttps://camsapi-staging.aquanow.com/apihttps://cams.cert.aquanow.com/api

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

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

afterstringOptional

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

limitstring · integerOptional

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

Responses

200

Successful response

application/json

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

get

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

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{accountId}/credit-limit/history?startDate=2024-02-01&endDate=2024-05-01 HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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

put

https://cams.aquanow.com/apihttp://localhost:3001/apihttps://camsapi-dev.aquanow.com/apihttps://camsapi-staging.aquanow.com/apihttps://cams.cert.aquanow.com/api

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

Set the credit limit of an account to the amount specified

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstring · uuidRequired

The account ID

Body

application/json

amountstring · numberRequiredExample: 10000

Responses

200

Successful response

application/json

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

put

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

HTTPcURLJavaScriptPython

PUT /api/v1/accounts/{accountId}/credit-limit HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "amount": "10000"
}

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

Increase or Decrease Credit Limit

patch

https://cams.aquanow.com/apihttp://localhost:3001/apihttps://camsapi-dev.aquanow.com/apihttps://camsapi-staging.aquanow.com/apihttps://cams.cert.aquanow.com/api

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

Applies an incremental change to the credit limit of an account

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstring · uuidRequired

The account ID

Body

application/json

amountstring · numberOptional

The amount to increase or decrease the credit limit by

Example: 10000

actionstring · enumOptional

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

Example: INCREASEPossible values:

Responses

200

Successful response

application/json

400

Validation Error

401

Unauthorized

403

Insufficient Privileges

4XX

Client error

5XX

Server error

patch

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

HTTPcURLJavaScriptPython

PATCH /api/v1/accounts/{accountId}/credit-limit HTTP/1.1
Host: cams.aquanow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "increaseAmount": "10000"
}

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