Add Cost Account

This operation creates cost account.

Key Considerations:

  • A cost account is an account used to maintain and segregate records for shipments, postage, and other operational data. There can be multiple Cost accounts, I.e; multiple Wallet - but one ledger.
  • Cost accounts allow to track which wallet was used for payment, maintain detailed payment history, and set budget notifications or thresholds.
  • Cost accounts are managed in a hierarchical structure: Enterprise > Division > Location.
  • Cost accounts can be assigned to a location, enabling client administrators to filter and analyze records based on the selected cost account.
  • A location can have one or more cost accounts assigned to it. This allows to filter shipments or postage records by selecting the cost account.
  • Cost accounts are assigned a status of either Active or Inactive.
  • Sub-Cost Accounts and Sub-Sub-Cost Accounts can also be created under the main cost account to further refine segregation.
SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-ID
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Request Body schema: application/json
name
required
string

this indicates the name of cost account

code
required
string

this indicates the code of cost account

passwordEnabled
boolean

Set to true when to enable password on cost account

passwordCode
string

Only required when passwordEnabled is true. this indicates the password you want to set. It should be alphanumeric and lenght of 4

description
string

this indicates the description you want to provide for cost account

status
boolean

Setting true creates cost account as Active and setting false makes it inactive

billable
boolean

set to true in case want to make cost account billable

parent
string

this indicates cost account Id of parent account

Responses
200

Cost Account Added Successfully

401

The request could not be authorized.

post/api/v1/costAccounts
Request samples
application/json
{
  • "name": "testname",
  • "code": "test01",
  • "passwordEnabled": true,
  • "passwordCode": "test",
  • "description": "test cost account",
  • "status": true,
  • "billable": true,
  • "parent": ""
}
Response samples
application/json
{
  • "accountID": "string"
}