Sign in
Accounting Codes

Retrieve an accounting code

This reference describes how to query an accounting code through the REST API.

get/v1/accounting-codes/{ac-id}

Path parameters

ac-idstring required

ID of the accounting code you want to query.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Response

OK

category'Assets' | 'Liabilities' | 'Equity' | 'Revenue' | 'Expenses'

The category associated with the accounting code.

createdBystring

The ID of the user who created the accounting code.

createdOnstring

Date and time when the accounting code was created.

glAccountNamestring nullable

Name of the account in your general ledger.

Field only available if you have Zuora Finance enabled.

glAccountNumberstring nullable

Account number in your general ledger.

Field only available if you have Zuora Finance enabled.

idstring

ID of the accounting code.

namestring

Name of the accounting code.

notesstring nullable

Any optional notes for the accounting code.

status'Active' | 'Inactive'

The accounting code status.

successboolean

Returns true if the request was processed successfully.

type'AccountsReceivable' | 'OnAccountReceivable' | 'Cash' | 'OtherAssets' | 'CustomerCashOnAccount' | 'DeferredRevenue' | 'SalesTaxPayable' | 'OtherLiabilities' | 'SalesRevenue' | 'SalesDiscounts' | 'OtherRevenue' | 'OtherEquity' | 'BadDebt' | 'OtherExpenses'

Accounting code type.

Note that OnAccountReceivable is only available if you enable the Invoice Settlement feature.

updatedBystring

The ID of the user who last updated the accounting code.

updatedOnstring

Date and time when the accounting code was last updated.

segmentConstantValuesSegmentConstantValuesCustomFields

Segment constant values. The field is available only if you have GL Segmentation 2.0 enabled.

This field is additional property.

Changes