Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
TransactionType

Create TransactionType

Create a new TransactionType for the specified Organization. Details of the new TransactionType should be included in the request body.

post/organizations/{orgId}/picklists/transactiontypes

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

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.
codestring

The short code for the entity.

namestring required

The name of the entity.

archivedboolean

A Boolean TRUE / FALSE flag indicating whether the entity is archived. An entity can be archived if it is obsolete.

  • TRUE - the entity is in the archived state.
  • FALSE - the entity is not in the archived state.

Example request

{
  "code": "code"
}

Response

Return the created TransactionType

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.
codestring

The short code of the data entity.

namestring

The name of the data entity.

archivedboolean

TRUE / FALSE flag indicating whether the data entity is archived. An entity can be archived if it is obsolete.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the TransactionType was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the TransactionType was last modified.

createdBystring

The unique identifier (UUID) of the user who created this TransactionType.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this TransactionType.