Skip to main content
https://.thoughtindustries.com

Create Credit Account

Creates a credit account for the specified client

Creates a credit account for the specified client.

POSThttps://example.thoughtindustries.com/incoming/v2/clients/:id/creditAccounts

Example request

curl -X POST "https://example.thoughtindustries.com/incoming/v2/clients/:id/creditAccounts" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "batchDaysUntilExpire": 0,
  "clientId": "00000000-0000-0000-0000-000000000000",
  "startingBalance": 0,
  "minimumBatchAmount": 0
}'

Parameters

NameTypeRequiredLocationDescription
idstringYespathThe id identifier.
batchDaysUntilExpireintegerNobodyNumber of days until a credit batch expires after being issued.
clientIduuidNobodyUnique identifier of the client to associate with this credit account.
startingBalancenumberYesbodyInitial credit balance assigned to the account at creation.
minimumBatchAmountintegerNobodyMinimum number of credits that must be included in a single credit batch.
notifyEmailsstring[]YesbodyList of email addresses to notify when account activity occurs (e.g. low balance).
typeCreditAccountTypeNobodyClassification of the credit account (e.g. client).
namestringYesbodyDisplay name for the credit account.
creditBatchNamestringNobodyLabel applied to credit batches issued under this account.
licenseIdsstring[]YesbodyList of license IDs to associate with this credit account.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string"
}

Response fields

FieldTypeDescription
iduuidIdentifier of the created credit account.
namestringName of the credit account.