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.

Request
header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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-Ids
string

Comma separated IDs. If you have Zuora Multi-Org 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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required
glAccountName
string

Name of the account in your general ledger.

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

glAccountNumber
string

Account number in your general ledger.

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

name
required
string

Name of the accounting code.

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

notes
string

Maximum of 2,000 characters.

type
required
string

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 On-Account Receivable is only available if you enable the Invoice Settlement feature.

Enum: "AccountsReceivable" "On-Account Receivable" "Cash" "OtherAssets" "CustomerCashOnAccount" "DeferredRevenue" "SalesTaxPayable" "OtherLiabilities" "SalesRevenue" "SalesDiscounts" "OtherRevenue" "OtherEquity" "BadDebt" "OtherExpenses"
property name*
additional property
any

Custom fields of the Accounting Code object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

Responses
200
500

Internal Server Error

4XX

Request Errors

post/v1/accounting-codes
Request samples
application/json
{
  • "name": "CASH",
  • "type": "Cash"
}
Response samples
application/json
{
  • "id": "8a8081ae547aac1e01547efb61f20140",
  • "success": true
}