Skip to main content
PUT
Update Revenue Transaction

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Body

tags
string
source
string | null
Maximum string length: 250
description
string | null
external_id
string | null
Maximum string length: 250
client_external_id
string | null
Maximum string length: 250
contract_external_id
string | null
Maximum string length: 250
contract_subscription_external_id
string | null
Maximum string length: 250
product_external_id
string | null
Maximum string length: 250
accounting_period
string<date> | null
transaction_date
string<date> | null
transaction_end_date
string<date> | null
currency
string
Maximum string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
recognized
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
amount
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
quantity
number<double> | null
Required range: -100000000000000 < x < 100000000000000
rate
number<double> | null
Required range: -10000000000000 < x < 10000000000000
discount
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
refunds
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
processing_fees
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
platform_fees
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
transfers
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
tax
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
balance_adjustment
number<double> | null

Invoice starting balance or other balance adjustments (e.g., previous balance applied to this transaction)

Required range: -1000000000000000000 < x < 1000000000000000000
mrr
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
renewall
boolean
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
is_migration_invoiced
boolean

Marked as invoiced during migration. Does not create GL entries or AR.

entity
integer | null
client
integer | null
contract
integer | null
contract_subscription
integer | null
non_contract_subscription
integer | null
contract_usage
integer | null
contract_milestone
integer | null
non_contract_usage
integer | null
prepaid_commit
integer | null
product
integer | null
product_bundle
integer | null
contract_product_bundle
integer | null

Reference to contract-specific editable product bundle allocation

contract_bundle
integer | null
journal_entry
integer | null
invoice
integer | null
credit_memo
integer | null
department
integer | null
usage_tier
integer | null

Response

200 - application/json
id
integer
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
entity_name
string
required
read-only
entity_currency
string
required
read-only
client_name
string
required
read-only
contract_name
string
required
read-only
contract_status
string
required
read-only
product_name
string
required
read-only
product_bundle_name
string
required
read-only
product_is_taxable
boolean
required
read-only
contract_identifier
string
required
read-only
client_identifier
string
required
read-only
product_identifier
string
required
read-only
gross_amount
string
required
read-only
invoice_number
string
required
read-only
invoice_date
string
required
read-only
invoice_payment_status
string
required
read-only
invoice_voided_date
string<date>
required
read-only
credit_memo_number
string
required
read-only
credit_memo_date
string<date>
required
read-only
credit_memo_voided_date
string<date>
required
read-only
credit_memo_application_status
string
required
read-only
revenue_type
string
required
read-only
journal_entry_order
string
required
read-only
contract_subscription_notes
string
required
read-only
subscription_discount
number<double> | null
required
read-only
Required range: -10000000000000 < x < 10000000000000
department_name
string
required
read-only
parent_department_name
string
required
read-only
parent_department
integer
required
read-only
usage_tier_name
string
required
read-only
last_modified_at
string<date-time>
required
read-only
anrok_item_id
string
required
read-only
sphere_item_id
string
required
read-only
created_at
string<date-time> | null
required
read-only
customer
integer
required
read-only
tags
string
source
string | null
Maximum string length: 250
description
string | null
external_id
string | null
Maximum string length: 250
client_external_id
string | null
Maximum string length: 250
contract_external_id
string | null
Maximum string length: 250
contract_subscription_external_id
string | null
Maximum string length: 250
product_external_id
string | null
Maximum string length: 250
accounting_period
string<date> | null
transaction_date
string<date> | null
transaction_end_date
string<date> | null
currency
string
Maximum string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
recognized
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
amount
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
quantity
number<double> | null
Required range: -100000000000000 < x < 100000000000000
rate
number<double> | null
Required range: -10000000000000 < x < 10000000000000
discount
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
refunds
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
processing_fees
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
platform_fees
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
transfers
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
tax
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
balance_adjustment
number<double> | null

Invoice starting balance or other balance adjustments (e.g., previous balance applied to this transaction)

Required range: -1000000000000000000 < x < 1000000000000000000
mrr
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
renewall
boolean
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
is_migration_invoiced
boolean

Marked as invoiced during migration. Does not create GL entries or AR.

entity
integer | null
client
integer | null
contract
integer | null
contract_subscription
integer | null
non_contract_subscription
integer | null
contract_usage
integer | null
contract_milestone
integer | null
non_contract_usage
integer | null
prepaid_commit
integer | null
product
integer | null
product_bundle
integer | null
contract_product_bundle
integer | null

Reference to contract-specific editable product bundle allocation

contract_bundle
integer | null
journal_entry
integer | null
invoice
integer | null
credit_memo
integer | null
department
integer | null
usage_tier
integer | null