SDK ReferenceTypeScript SDKTransactions

Create a new transaction

Add a new transaction to the company ledger

Path parameters

idstringRequired

Company ID

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
idstringOptional

Unique identifier for the transaction

datedatetimeOptional

Date of the transaction

amountdoubleOptional

Amount of the transaction

currencystringOptional

Currency of the transaction

descriptionstringOptional

Description of the transaction

statusenumOptional

Status of the transaction

Allowed values:
created_byintegerOptional

ID of the user who created the transaction

updated_byintegerOptional

ID of the user who last updated the transaction

created_atdatetimeOptional

Date when the transaction was created

updated_atdatetimeOptional

Date when the transaction was last updated

bank_transaction_idstringOptional

ID of the bank transaction

transaction_typeenumOptional

Type of transaction

Allowed values:
ledger_typeenumOptional

Ledger type of the transaction

bank_account_idstringOptional

ID of the bank account

business_idstringOptional

ID of the business

directionenumOptional

Direction of the transaction

Allowed values:
balancedoubleOptional

Balance after the transaction

counterparty_namestringOptional

Name of the counterparty

categorizationStatusenumOptional

Status of categorization

Allowed values:
category_idintegerOptional

ID of the category

company_idstringOptional

ID of the company

metadataobjectOptional

Additional metadata for the transaction

Response

Transaction created successfully

idstringOptional

Unique identifier for the transaction

datedatetimeOptional

Date of the transaction

amountdoubleOptional

Amount of the transaction

currencystringOptional

Currency of the transaction

descriptionstringOptional

Description of the transaction

statusenumOptional

Status of the transaction

Allowed values:
created_byintegerOptional

ID of the user who created the transaction

updated_byintegerOptional

ID of the user who last updated the transaction

created_atdatetimeOptional

Date when the transaction was created

updated_atdatetimeOptional

Date when the transaction was last updated

bank_transaction_idstringOptional

ID of the bank transaction

transaction_typeenumOptional

Type of transaction

Allowed values:
ledger_typeenumOptional

Ledger type of the transaction

bank_account_idstringOptional

ID of the bank account

business_idstringOptional

ID of the business

directionenumOptional

Direction of the transaction

Allowed values:
balancedoubleOptional

Balance after the transaction

counterparty_namestringOptional

Name of the counterparty

categorizationStatusenumOptional

Status of categorization

Allowed values:
category_idintegerOptional

ID of the category

company_idstringOptional

ID of the company

metadataobjectOptional

Additional metadata for the transaction

Errors