Revenue Recognition Schedules

Revenue Recognition Schedules

Gets all of the revenue recognition schedules in the system.

This method will scan all revenue recognition schedules and and return them to the caller.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The revenue recognition scheduleswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/revenueRecognitionSchedules/{tenantId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/revenueRecognitionSchedules/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a revenue recognition schedule from the system by its ID.

This method will look up a revenue recognition schedule by the specified ID and return it back.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the revenue recognition schedule to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The revenue recognition schedule was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The revenue recognition schedule could not be found.
429Limit exceeded... unable to retrieve revenue recognition schedule based on tenant limits.
500General server error.
get/revenueRecognitionSchedules/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/revenueRecognitionSchedules/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type": "invoice",
  • "batch_id": "string",
  • "date": "string",
  • "membership_id": "string",
  • "notes": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "revenue_gl_account_id": "string",
  • "parent_schedule_id": "string",
  • "business_unit_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_name": "string",
  • "transaction_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "refund_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "write_off_id": "string",
  • "invoice_line_item_id": "string",
  • "payment_line_item_id": "string",
  • "currency_code": "str",
  • "status": "open",
  • "entries": [
    ],
  • "revenue_splits": [
    ],
  • "sys_business_unit_status": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Updates a revenue recognition schedule with the specified ID.

This method will update an existing revenue recognition schedule with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the revenue recognition schedule to update.

Request Body schema: application/json

The updated revenue recognition schedule that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this revenue recognition schedule

type
required
string (Type)
Enum: "invoice" "credit memo" "debit memo" "write off" "payment" "refund"
batch_id
required
string (Batch)

The batch that posted the schedule

date
string (Date)
membership_id
string (Membership)

The membership this schedule is tied to

notes
string (Notes)

Optional notes/description for the schedule

deferred_revenue_gl_account_id
required
string (Deferred Revenue Gl Account)
revenue_gl_account_id
required
string (Revenue Gl Account)
parent_schedule_id
string (Parent Schedule)

The parent schedule, if this schedule is related to another

business_unit_id
required
string (Business Unit)

The business unit this schedule belongs to

product_type
required
string (Product Type)

The type of product being deferred

product_id
required
string (Product)

The ID of the product

product_name
string (Product Name)

The name of the product

transaction_id
required
string (Transaction)

The transaction ID

invoice_id
required
string (Invoice)
payment_id
required
string (Payment)
refund_id
required
string (Refund)
credit_memo_id
required
string (Credit Memo)
debit_memo_id
required
string (Debit Memo)
write_off_id
required
string (Write Off)
invoice_line_item_id
required
string (Invoice Line Item)
payment_line_item_id
required
string (Payment Line Item)
currency_code
required
string (Currency Code) 3 characters

The currency code for the revenue recognition schedule

status
required
string (Status)
Enum: "open" "closed"
required
Array of objects non-empty
Array of objects
sys_business_unit_status
string (Sys Business Unit Status)

Concatenation of the business unit id and the status, used for indexing

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

Responses
200The revenue recognition schedule was updated successfully.
400The revenue recognition schedule supplied was not valid.
401Unauthorized.
403Forbidden.
404The revenue recognition schedule could not be found.
409The revenue recognition schedule could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve revenue recognition schedule based on tenant limits.
500General server error.
put/revenueRecognitionSchedules/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "type": "invoice",
  • "batch_id": "string",
  • "date": "string",
  • "membership_id": "string",
  • "notes": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "revenue_gl_account_id": "string",
  • "parent_schedule_id": "string",
  • "business_unit_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_name": "string",
  • "transaction_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "refund_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "write_off_id": "string",
  • "invoice_line_item_id": "string",
  • "payment_line_item_id": "string",
  • "currency_code": "str",
  • "status": "open",
  • "entries": [
    ],
  • "revenue_splits": [
    ],
  • "sys_business_unit_status": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "type": "invoice",
  • "batch_id": "string",
  • "date": "string",
  • "membership_id": "string",
  • "notes": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "revenue_gl_account_id": "string",
  • "parent_schedule_id": "string",
  • "business_unit_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_name": "string",
  • "transaction_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "refund_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "write_off_id": "string",
  • "invoice_line_item_id": "string",
  • "payment_line_item_id": "string",
  • "currency_code": "str",
  • "status": "open",
  • "entries": [
    ],
  • "revenue_splits": [
    ],
  • "sys_business_unit_status": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Partially updates a revenue recognition schedule with the specified ID.

This method will patch an existing revenue recognition schedule with the specified ID, using the HTTP PATCH specification.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the revenue recognition schedule to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The revenue recognition schedule was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The revenue recognition schedule could not be found.
409The revenue recognition schedule could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve revenue recognition schedule based on tenant limits.
500General server error.
patch/revenueRecognitionSchedules/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "type": "invoice",
  • "batch_id": "string",
  • "date": "string",
  • "membership_id": "string",
  • "notes": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "revenue_gl_account_id": "string",
  • "parent_schedule_id": "string",
  • "business_unit_id": "string",
  • "product_type": "string",
  • "product_id": "string",
  • "product_name": "string",
  • "transaction_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "refund_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "write_off_id": "string",
  • "invoice_line_item_id": "string",
  • "payment_line_item_id": "string",
  • "currency_code": "str",
  • "status": "open",
  • "entries": [
    ],
  • "revenue_splits": [
    ],
  • "sys_business_unit_status": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Returns a list of records with the specified batch_id

Returns a list of records with the specified batch_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

batch_id
required
string

The batch_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/revenueRecognitionSchedules/{tenantId}/batch/{batch_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/revenueRecognitionSchedules/:tenantId/batch/:batch_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified invoice_id

Returns a list of records with the specified invoice_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

invoice_id
required
string

The invoice_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/revenueRecognitionSchedules/{tenantId}/invoice/{invoice_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/revenueRecognitionSchedules/:tenantId/invoice/:invoice_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of OPEN records with the specified business_unit_id

Returns a list of OPEN records with the specified business_unit_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

business_unit_id
required
string

The business_unit_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/revenueRecognitionSchedules/{tenantId}/businessUnit/{business_unit_id}/open
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/revenueRecognitionSchedules/:tenantId/businessUnit/:business_unit_id/open?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified payment_id

Returns a list of records with the specified payment_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

payment_id
required
string

The payment_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/revenueRecognitionSchedules/{tenantId}/payment/{payment_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/revenueRecognitionSchedules/:tenantId/payment/:payment_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified membership_id

Returns a list of records with the specified membership_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

membership_id
required
string

The membership_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/revenueRecognitionSchedules/{tenantId}/membership/{membership_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/revenueRecognitionSchedules/:tenantId/membership/:membership_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}