July 18, 2025

Jump to

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 GET /v3/Contacts/{ContactKey} and GET /v3/Organization/{OrganizationKey} endpoints to include new fields for these services.

The response now includes the following properties:

Accounting
Bank
Benefits
BillPay
Expenses
FileManagement
LegalFirm
Payroll
Revenue
TaxProvider

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

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

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

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

Without the OrganizationKey the payload might look like:

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

If not service is set at all, the value will be null, e.g.

"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 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., Payroll or BillPay), use an empty array []
For object-based services (LegalFirm and TaxProvider), use an empty object {}

If a service field is not included in the 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.