Sign in
Charge

Create Charge

Create a new Charge.

NOTES:

  • To create an ad-hoc Charge on an Account, use the accountId request parameter.
  • To create a balance fee Charge for a Balance, use the entityId request parameter to specify which Balance on an Account the Charge is for.
  • To define the value of the Charge amount that is billed, you can simply specify an amount or use a number of units together with a unitPrice for a calculated value = units x unit price. But you cannot specify both an amount and units/unit price.
post/organizations/{orgId}/charges

Path parameters

orgIdstring required

UUID of the organization

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
namestring required

Name of the Charge. Added to the Bill line item description for this Charge.

codestring required

Unique short code for the Charge.

accountIdstring required

The ID of the Account the Charge is being created for.

billDatestring

The date when the Charge will be added to a Bill.

amountnumber

Amount of the Charge. If amount is provided, then units and unitPrice must be omitted.

unitsnumber

Number of units of the Charge. If amount is omitted, then provide together with unitPrice. When amount is provided, units must be omitted.

unitPricenumber

Unit price. If amount is omitted, then provide together with units. When amount is provided, unitPrice must be omitted.

currencystring required

Charge currency.

descriptionstring

The description added to the Bill line item for the Charge.

entityType'AD_HOC' | 'BALANCE' required

The entity this charge is created for, ex: Balance or AD_HOC if none applies

lineItemType'BALANCE_FEE' | 'AD_HOC' required

The Line Item Type to be used for this Charge

entityIdstring

The ID of the Charge linked entity. For example, the ID of an Account Balance if a Balance Charge.

NOTE: If entityType is BALANCE, you must provide the entityId of the Balance the Charge is for.

accountingProductIdstring

The Accounting Product ID assigned to the Charge.

servicePeriodStartDatestring date-time required

The service period start date (in ISO-8601 format) for the Charge.

servicePeriodEndDatestring date-time required

The service period end date (in ISO-8601 format)for the Charge.

NOTE: End date is exclusive.

notesstring

Used to enter information about the Charge for accounting purposes, such as the reason it was created. This information will not be added to a Bill line item for the Charge.

contractIdstring

The ID of a Contract on the Account that the Charge will be added to.

Example request

{
  "billDate": "2022-01-04"
}

Response

Returns the created Charge

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.

Changes

Changed in 2 of the 10 revisions of this API.4

  • ac93d1a9e6d93See the full diff
    • ○

      added the new optional request property allOf[subschema #2]/unitPrice

      new-optional-request-property

    • ○

      the request property allOf[subschema #2]/amount became optional

      request-property-became-optional

    • ○

      added the optional property unitPrice to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9f9e5f3dbde71See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog