Create CreditTransaction
curl --request POST \
--url https://platform.kodexa.ai/api/credit-transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 123,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"note": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"transactionId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/credit-transactions"
payload = {
"amount": 123,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"note": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"transactionId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<string>"] },
"showDeveloperTools": True,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
id: '<string>',
note: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
transactionId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
user: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<string>']},
showDeveloperTools: true,
title: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
userStorage: {favoriteLinks: [{link: '<string>'}]},
userType: '<string>',
uuid: '<string>'
},
userId: '<string>',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/credit-transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/credit-transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 123,
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'id' => '<string>',
'note' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'transactionId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'user' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<string>'
]
],
'showDeveloperTools' => true,
'title' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'userStorage' => [
'favoriteLinks' => [
[
'link' => '<string>'
]
]
],
'userType' => '<string>',
'uuid' => '<string>'
],
'userId' => '<string>',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/credit-transactions"
payload := strings.NewReader("{\n \"amount\": 123,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"note\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/credit-transactions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"note\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/credit-transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"note\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount": 123,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"note": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"transactionId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>",
"uuid": "<string>"
}Credit Transactions
Create CreditTransaction
Creates a new CreditTransaction. Credit transactions record billing credit usage or additions.
POST
/
api
/
credit-transactions
Create CreditTransaction
curl --request POST \
--url https://platform.kodexa.ai/api/credit-transactions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 123,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"note": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"transactionId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/credit-transactions"
payload = {
"amount": 123,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"note": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"transactionId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<string>"] },
"showDeveloperTools": True,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
id: '<string>',
note: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
transactionId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
user: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<string>']},
showDeveloperTools: true,
title: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
userStorage: {favoriteLinks: [{link: '<string>'}]},
userType: '<string>',
uuid: '<string>'
},
userId: '<string>',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/credit-transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/credit-transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 123,
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'id' => '<string>',
'note' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'transactionId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'user' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<string>'
]
],
'showDeveloperTools' => true,
'title' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'userStorage' => [
'favoriteLinks' => [
[
'link' => '<string>'
]
]
],
'userType' => '<string>',
'uuid' => '<string>'
],
'userId' => '<string>',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/credit-transactions"
payload := strings.NewReader("{\n \"amount\": 123,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"note\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/credit-transactions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"note\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/credit-transactions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"note\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"amount": 123,
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"note": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"transactionId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>",
"uuid": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
A credit transaction records a billing credit usage or addition for an organization.
An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
Show child attributes
Show child attributes
A platform user represents a user account in the Kodexa platform.
Show child attributes
Show child attributes
Response
Created CreditTransaction
A credit transaction records a billing credit usage or addition for an organization.
An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.
Show child attributes
Show child attributes
A platform user represents a user account in the Kodexa platform.
Show child attributes
Show child attributes
⌘I