v1
latestOpenAPI 3.0.32026-07-26362271803.3 KBRevenue Recognition
Create Revenue Transaction
Create a new revenue transaction
post/rr/api/v1/transactions
Request body
idinteger required
is_deletedboolean required
deleted_atstring date-time nullable required
entity_namestring required
entity_currencystring required
client_namestring required
contract_namestring required
contract_statusstring required
product_namestring required
product_bundle_namestring required
product_is_taxableboolean required
contract_identifierstring required
client_identifierstring required
product_identifierstring required
gross_amountstring required
invoice_numberstring required
invoice_datestring required
invoice_payment_statusstring required
invoice_voided_datestring date required
credit_memo_numberstring required
credit_memo_datestring date required
credit_memo_voided_datestring date required
credit_memo_application_statusstring required
revenue_typestring required
journal_entry_orderstring required
contract_subscription_notesstring required
subscription_discountnumber double nullable required
department_namestring required
parent_department_namestring required
parent_departmentinteger required
tagsstring
usage_tier_namestring required
last_modified_atstring date-time required
anrok_item_idstring required
sphere_item_idstring required
sourcestring nullable
descriptionstring nullable
external_idstring nullable
client_external_idstring nullable
contract_external_idstring nullable
contract_subscription_external_idstring nullable
product_external_idstring nullable
accounting_periodstring date nullable
transaction_datestring date nullable
transaction_end_datestring date nullable
currencystring
exchange_ratenumber double nullable
exchange_rate_booknumber double nullable
recognizednumber double nullable
amountnumber double nullable
quantitynumber double nullable
ratenumber double nullable
discountnumber double nullable
refundsnumber double nullable
processing_feesnumber double nullable
platform_feesnumber double nullable
transfersnumber double nullable
taxnumber double nullable
balance_adjustmentnumber double nullable
Invoice starting balance or other balance adjustments (e.g., previous balance applied to this transaction)
mrrnumber double nullable
renewallboolean
tag_idsinteger[]
tag_group_idsinteger[]
is_migration_invoicedboolean
Marked as invoiced during migration. Does not create GL entries or AR.
created_atstring date-time nullable required
customerinteger required
entityinteger nullable
clientinteger nullable
contractinteger nullable
contract_subscriptioninteger nullable
non_contract_subscriptioninteger nullable
contract_usageinteger nullable
contract_milestoneinteger nullable
non_contract_usageinteger nullable
prepaid_commitinteger nullable
productinteger nullable
product_bundleinteger nullable
contract_product_bundleinteger nullable
Reference to contract-specific editable product bundle allocation
contract_bundleinteger nullable
journal_entryinteger nullable
invoiceinteger nullable
credit_memointeger nullable
departmentinteger nullable
usage_tierinteger nullable
Response
idinteger required
is_deletedboolean required
deleted_atstring date-time nullable required
entity_namestring required
entity_currencystring required
client_namestring required
contract_namestring required
contract_statusstring required
product_namestring required
product_bundle_namestring required
product_is_taxableboolean required
contract_identifierstring required
client_identifierstring required
product_identifierstring required
gross_amountstring required
invoice_numberstring required
invoice_datestring required
invoice_payment_statusstring required
invoice_voided_datestring date required
credit_memo_numberstring required
credit_memo_datestring date required
credit_memo_voided_datestring date required
credit_memo_application_statusstring required
revenue_typestring required
journal_entry_orderstring required
contract_subscription_notesstring required
subscription_discountnumber double nullable required
department_namestring required
parent_department_namestring required
parent_departmentinteger required
tagsstring
usage_tier_namestring required
last_modified_atstring date-time required
anrok_item_idstring required
sphere_item_idstring required
sourcestring nullable
descriptionstring nullable
external_idstring nullable
client_external_idstring nullable
contract_external_idstring nullable
contract_subscription_external_idstring nullable
product_external_idstring nullable
accounting_periodstring date nullable
transaction_datestring date nullable
transaction_end_datestring date nullable
currencystring
exchange_ratenumber double nullable
exchange_rate_booknumber double nullable
recognizednumber double nullable
amountnumber double nullable
quantitynumber double nullable
ratenumber double nullable
discountnumber double nullable
refundsnumber double nullable
processing_feesnumber double nullable
platform_feesnumber double nullable
transfersnumber double nullable
taxnumber double nullable
balance_adjustmentnumber double nullable
Invoice starting balance or other balance adjustments (e.g., previous balance applied to this transaction)
mrrnumber double nullable
renewallboolean
tag_idsinteger[]
tag_group_idsinteger[]
is_migration_invoicedboolean
Marked as invoiced during migration. Does not create GL entries or AR.
created_atstring date-time nullable required
customerinteger required
entityinteger nullable
clientinteger nullable
contractinteger nullable
contract_subscriptioninteger nullable
non_contract_subscriptioninteger nullable
contract_usageinteger nullable
contract_milestoneinteger nullable
non_contract_usageinteger nullable
prepaid_commitinteger nullable
productinteger nullable
product_bundleinteger nullable
contract_product_bundleinteger nullable
Reference to contract-specific editable product bundle allocation
contract_bundleinteger nullable
journal_entryinteger nullable
invoiceinteger nullable
credit_memointeger nullable
departmentinteger nullable
usage_tierinteger nullable