Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > AccountingCode

AccountingCode

Use the AccountingCode object to create and manage accounting codes for the Zuora Chart of Accounts.

How Accounting Codes are Used in Zuora

See Assign Accounting Codes for more information on how to manage accounting codes using the Zuora user interface. See Set up Chart of Accounts for additional information.

Supported Calls

You can use this object with the following calls:

Permissions

Permissions and use of certain fields depend on whether your tenant has access to Z-Finance:

  • For tenants with access to Z-Finance, you have access to all fields. Two user permissions are required and available by default to all Z-Finance roles: Create Accounting Code and Manage Accounting Code.
  • For other tenants, you have access to the Chart of Accounts, but not to the GLAccountName and GLAccountNumber fields. User permissions to create or manage accounting codes are available only to tenants with Z-Finance.

To delete an accounting code, you must have the Delete Unused Accounting Code permission.

Fields requiring Z-Finance are noted in the following field descriptions table.

Field Descriptions

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.

Name Required to Create? Allowed
Operations
Description

Category

Optional

Query

The category associated with the accounting code. Possible values:

  • Assets
  • Liabilities
  • Equity
  • Revenue
  • Expenses

Type: enum

Character limit: N/A

Version: WSDL 50.0+

Z-Finance RequiredNo

CreatedById

Optional

Query

The identifier of the user who created the accounting code.

Type: string ID

Character limit: N/A

Version: WSDL 50.0+

Z-Finance RequiredNo

CreatedDate

Optional

Query

The date when the accounting code was created.

Type: dateTime

Character limit: N/A

Version: WSDL 50.0+

Z-Finance RequiredNo

GLAccountName

Optional

Create
Query
Update

The account name in general ledger (GL) that corresponds to accounting code.

Type: String

Character limit: 255

Version: WSDL 50.0+

Z-Finance Required: Yes

GLAccountNumber

Optional

Create
Query
Update

The account number in the GL that corresponds to the accounting code.

Type: String

Character limit: 50

Version: WSDL 50.0+

Z-Finance Required: Yes

Id Optional Query
Filter

ID of object.

Type: zns:IDzns:ID
Character limit: 32
Version notes: --
Values: automatically generated

Name

Required

Create
Query
Update

The name of the accounting code.

Type: string

Character limit: 100

Version: WSDL 50.0+

Z-Finance Required: No

Notes

Optional

Create

Query
Update

Any note about the accounting code.

Type: String

Character limit: 2000

Version: WSDL 50.0+

Z-Finance Required: No

Status

Optional

 

Query
Update

The accounting code status. On create, the accounting code is created in Active status by default. Possible values:

  • Active
  • Inactive

Type: enum

Character limit: N/A

Version: WSDL 50.0+

Z-Finance RequiredNo

Type

Required

 

Create
Query
Update

The accounting code type. Possible values:

  • AccountsReceivable
  • Cash
  • OtherAssets
  • CustomerCashOnAccount
  • DeferredRevenue
  • SalesTaxPayable
  • OtherLiabilities
  • SalesRevenue
  • SalesDiscounts
  • OtherRevenue
  • OtherEquity
  • BadDebt
  • OtherExpenses

Type: enum

Character limit: N/A

Version: WSDL 50.0+

Z-Finance Required: No

UpdatedById

Optional

Query

The identifier of the user who created the accounting code.

Type: string ID

Character limit: N/A

Version: WSDL 50.0+

Z-Finance Required: No

UpdatedDate

Optional

Query

The date when the accounting code was updated.

Type: dateTime

Character limit: N/A

Version: WSDL 50.0+

Z-Finance RequiredNo

Examples

Create an Accounting Code using a SOAP Wrapper

<?xml version="1.0" encoding="http://schemas.xmlsoap.org/soap/envelope/" standalone="no"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.zuora.com/" xmlns:obj="http://object.api.zuora.com/">
<soapenv:Header>
  <api:SessionHeader>
     <api:session>[replace with your session]</api:session>
  </api:SessionHeader>
  <api:CallOptions>
    <api:useSingleTransaction>false</api:useSingleTransaction>
  </api:CallOptions>
</soapenv:Header>
<soapenv:Body>
  <api:create>
    <api:zObjects xsi:type="ns381:AccountingCode" xmlns:ns381="http://object.api.zuora.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <ns381:Name>012456789012345</ns381:Name>
      <ns381:Type>OtherLiabilities</ns381:Type>
      <ns381:GLAccountNumber>123</ns381:GLAccountNumber>
      <ns381:GLAccountName>123GLName</ns381:GLAccountName>
      <ns381:Notes>AnyNote</ns381:Notes>
    </api:zObjects>
  </api:create>
</soapenv:Body>
</soapenv:Envelope>

Update an Accounting Code with a SOAP Wrapper

<?xml version="1.0" encoding="http://schemas.xmlsoap.org/soap/envelope/" standalone="no"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.zuora.com/" xmlns:obj="http://object.api.zuora.com/">
<soapenv:Header>
  <api:SessionHeader>
    <api:session>[replace with your session]</api:session>
  </api:SessionHeader>
</soapenv:Header>
<soapenv:Body>
  <api:update>
    <api:zObjects xsi:type="ns381:AccountingCode" xmlns:ns381="http://object.api.zuora.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <obj:Id>2c9081fb407eec5201407f4d187c0003</obj:Id>
        <ns381:Name>YourAccountingCodeName</ns381:Name>
    </api:zObjects>
  </api:update>
</soapenv:Body>
</soapenv:Envelope>

Query an Accounting Code with a SOAP Wrapper

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.zuora.com/">
<soapenv:Header>
  <api:SessionHeader>
    <api:session>[replace with your session]</api:session>
  </api:SessionHeader>
</soapenv:Header>
<soapenv:Body>
  <api:query>
    <api:queryString>select Id, UpdatedDate, Name from AccountingCode where status = 'Active'</api:queryString>
    </api:query>
</soapenv:Body>
</soapenv:Envelope>

 

 
Last modified
23:37, 30 Nov 2016

Tags

Classifications

(not set)