July 18, 2025

July 18, 2025 Karbon API release adds additional Accounting Details fields

Services in client Accounting Detail

The Accounting Detail section in client records in Karbon includes several fields that let firms note which services a client uses. These services include Bank, Payroll Provider, and Legal Firm.

This release has extended the API responses for

JSONCopied!

GET /v3/Contacts/{ContactKey}

and

JSONCopied!

GET /v3/Organization/{OrganizationKey}

endpoints to include new fields for these services.

The response now includes the following properties:

JSONCopied!
Accounting
JSONCopied!
Bank
JSONCopied!
Benefits
JSONCopied!
BillPay
JSONCopied!
Expenses
JSONCopied!
FileManagement
JSONCopied!
LegalFirm
JSONCopied!
Payroll
JSONCopied!
Revenue
JSONCopied!
TaxProvider

Each property returns one or more text strings if values are set, or an empty array if not. For example:

JSONCopied!
"BillPay": ["EasyBill"],
"Payroll": []

The

JSONCopied!

LegalFirm

and

JSONCopied!

TaxProvider

properties behave differently, returning an object that may include a reference to another Organization in Karbon, with Name and OrganizationKey fields. For example:

JSONCopied!
"LegalFirm": {
  "Name": "Polygon Legal",
  "OrganizationKey": "4cYDk82rZDRn"
}

Without the

JSONCopied!

OrganizationKey

the payload might look like:

JSONCopied!
"TaxProvider": {
  "Name": "Orbit Tax",
  "OrganizationKey": null
},

If not service is set at all, the value will be

JSONCopied!

null

, e.g.

JSONCopied!
"TaxProvider": null

Refer to the GET Contact by ContactKey and GET Organization by OrganizationKey sections of the API documentation for complete examples.

Updating Services in client Accounting Detail

You can also add or update these service fields using a

JSONCopied!

PUT

request when updating a client record.

To update a service, simply include the relevant key and value in the payload.

To remove a value:

For list-based services (e.g.,
JSONCopied!
Payroll
or
JSONCopied!
BillPay
), use an empty array
JSONCopied!
[]
For object-based services (
JSONCopied!
LegalFirm
and
JSONCopied!
TaxProvider
), use an empty object
JSONCopied!
{}

If a service field is not included in the

JSONCopied!

PUT

request payload, its existing value will remain unchanged.

Refer to the Contact PUT and Organization PUT sections of the API documentation for complete examples.

Prev Next