Sign in
Accounting Codes

Create an accounting code

This reference describes how to create a new accounting code through the REST API. The accounting code will be active as soon as it has been created.

Prerequisites

If you have Zuora Finance enabled on your tenant, you must have the Configure Accounting Codes permission.

post/v1/accounting-codes

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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.

Request body

glAccountNamestring

Name of the account in your general ledger.

Field only available if you have Zuora Finance enabled. Maximum of 255 characters.

glAccountNumberstring

Account number in your general ledger.

Field only available if you have Zuora Finance enabled. Maximum of 255 characters.

namestring required

Name of the accounting code.

Accounting code name must be unique. Maximum of 100 characters.

notesstring

Maximum of 2,000 characters.

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

If you want to create multiple accounting codes of the type AccountsReceivable, you need to have Invoice Item Settlement enabled and contact Zuora Global Support to access the Multiple AR Accounting Codes feature.

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

segmentConstantValuesSegmentConstantValuesCustomFields

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

This field is additional property.

Example request

{
  "name": "CASH",
  "type": "Cash"
}

Response

OK

idstring

ID of the newly created accounting code.

successboolean

Returns true if the request was processed successfully.

Changes