Revenue Recognition Schedules

Accounting Projects

Operations

Bank Accounts

Operations

Batch Assignment Settings

Operations

Batch Downloading

Operations

Batch Posting

Operations

Batch Templates

Operations

Batches

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Business Units

Operations

Check Request Processes

Operations

Check Request Templates

Operations

Check Requests

Operations

Cogs Entries

Operations

Credit Memos

Operations

Credits

Operations

Currency Mapping Policies

Operations

Debit Memos

Operations

Departments

Operations

Donation Products

Operations

Exchange Rates

Operations

External Payments

Operations

Fiscal Years

Operations

Gateway Entities

Operations

Gateway Entries

Operations

Gateway Fees

Operations

Gl Accounts

Operations

Installment Plans

Operations

Installment Schedules

Operations

Invoice Payment Terms

Operations

Invoice Templates

Operations

Invoice Types

Operations

Invoices

Operations

Late Fee Rules

Operations

Late Fees

Operations

Legacy Import Products

Operations

Merchant Accounts

Operations

Miscellaneous Products

Operations

Payment Receipt Templates

Operations

Payments

Operations

Product Financial Configs

Operations

Query Definitions

Operations

Recurring Batches

Operations

Recurring Billing Runs

Operations

Refund Receipt Templates

Operations

Refunds

Operations

Revenue Recognition Schedules

Operations

Gets all of the revenue recognition schedules in the system.

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The revenue recognition scheduleswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

batch_idstring(Batch)required

The batch that posted the schedule

business_unit_idstring(Business Unit)required

The business unit this schedule belongs to

contact_idstring(Contact)

Contact that owns this

credit_memo_idstring(Credit Memo)required

currency_codestring(Currency Code)= 3 charactersrequired

The currency code for the revenue recognition schedule

custom_field_valuesArray of objects(Custom Field Values)

customer_typestring(Customer Type)

The type of customer that "owns" this schedule

datestring(Date)

debit_memo_idstring(Debit Memo)required

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

entries[].batch_idBatch (string)(Batch)

The batch that recognized this entry

One of:

The batch that recognized this entry

string(Batch)

entries[].cogs_batch_idstring(Cogs Batch)

The ID of the batch used to track COGS

entries[].datestring(Date)required

entries[].deferral_batch_idstring(Deferral Batch)

The ID of the batch used to process deferrals

entries[].deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entries[].entry_idstring(Entry)required

entries[].parent_entry_idstring(Parent Entry)

entries[].recognized_in_fiscal_periodnumber(float)(Recognized In Fiscal Period)[ 1 .. 23 ]

The fiscal period in which this entry was recognized

entries[].recognized_in_fiscal_year_idstring(Recognized In Fiscal Year)

The fiscal year in which this entry was recognized

entries[].revenue_gl_account_idstring(Revenue Gl Account)required

entries[].revenue_split_idstring(Revenue Split)

entries[].statusstring(Status)required

Enum"error""recognized""unrecognized"

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this revenue recognition schedule

invoice_idstring(Invoice)required

invoice_line_item_idstring(Invoice Line Item)required

membership_idstring(Membership)

The membership this schedule is tied to

notesstring(Notes)

Optional notes/description for the schedule

organization_idstring(Organization)

Organization that owns this

parent_schedule_idstring(Parent Schedule)

The parent schedule, if this schedule is related to another

payment_idstring(Payment)required

payment_line_item_idstring(Payment Line Item)required

product_idstring(Product)required

The ID of the product

product_namestring(Product Name)

The name of the product

product_typestring(Product Type)required

The type of product being deferred

product_versionnumber(float)(Product Version)

The versino of the product that created this schedule

recognized_amountnumber(float)(Recognized Amount)required

The amount of revenue that has been recognized

refund_idstring(Refund)required

revenue_gl_account_idstring(Revenue Gl Account)required

revenue_splitsArray of objects

statusstring(Status)required

Enum"closed""open"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_business_unit_statusstring(Sys Business Unit Status)

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

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(float)(Total)required

The total to be recognized in this schedule

transaction_idstring(Transaction)required

The transaction ID

typestring(Type)required

Enum"credit memo""debit memo""invoice""payment""refund""write off"

unrecognized_amountnumber(float)(Unrecognized Amount)required

The unrecognized amount of revenue

write_off_idstring(Write Off)required

]

Response

application/json

[
  {
    "batch_id": "string",
    "business_unit_id": "string",
    "contact_id": "string",
    "credit_memo_id": "string",
    "currency_code": "str",
    "custom_field_values": [ … ],
    "customer_type": "string",
    "date": "string",
    "debit_memo_id": "string",
    "deferred_revenue_gl_account_id": "string",
    "entries": [ … ],
    "id": "string",
    "invoice_id": "string",
    "invoice_line_item_id": "string",
    "membership_id": "string",
    "notes": "string",
    "organization_id": "string",
    "parent_schedule_id": "string",
    "payment_id": "string",
    "payment_line_item_id": "string",
    "product_id": "string",
    "product_name": "string",
    "product_type": "string",
    "product_version": 0.1,
    "recognized_amount": 0.1,
    "refund_id": "string",
    "revenue_gl_account_id": "string",
    "revenue_splits": [ … ],
    "status": "closed",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_business_unit_status": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": 0.1,
    "transaction_id": "string",
    "type": "credit memo",
    "unrecognized_amount": 0.1,
    "write_off_id": "string"
  }
]

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a list of records with the specified batch_id

Request

Returns a list of records with the specified batch_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

batch_idstringrequired

The batch_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/batch/{batch_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of OPEN records with the specified business_unit_id

Request

Returns a list of OPEN records with the specified business_unit_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

business_unit_idstringrequired

The business_unit_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/businessUnit/{business_unit_id}/open?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified credit_memo_id

Request

Returns a list of records with the specified credit_memo_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

credit_memo_idstringrequired

The credit_memo_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/creditMemo/{credit_memo_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified debit_memo_id

Request

Returns a list of records with the specified debit_memo_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

debit_memo_idstringrequired

The debit_memo_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/debitMemo/{debit_memo_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified invoice_id

Request

Returns a list of records with the specified invoice_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

invoice_idstringrequired

The invoice_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/invoice/{invoice_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified membership_id

Request

Returns a list of records with the specified membership_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

membership_idstringrequired

The membership_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/membership/{membership_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified payment_id

Request

Returns a list of records with the specified payment_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

payment_idstringrequired

The payment_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/payment/{payment_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified write_off_id

Request

Returns a list of records with the specified write_off_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

write_off_idstringrequired

The write_off_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/writeOff/{write_off_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(RevenueRecognitionSchedule)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

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

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the revenue recognition schedule to return.

Query

fieldsstring

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

consistentReadstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/{id}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The revenue recognition schedule was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

batch_idstring(Batch)required

The batch that posted the schedule

business_unit_idstring(Business Unit)required

The business unit this schedule belongs to

contact_idstring(Contact)

Contact that owns this

credit_memo_idstring(Credit Memo)required

currency_codestring(Currency Code)= 3 charactersrequired

The currency code for the revenue recognition schedule

custom_field_valuesArray of objects(Custom Field Values)

customer_typestring(Customer Type)

The type of customer that "owns" this schedule

datestring(Date)

debit_memo_idstring(Debit Memo)required

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

entries[].batch_idBatch (string)(Batch)

The batch that recognized this entry

One of:

The batch that recognized this entry

string(Batch)

entries[].cogs_batch_idstring(Cogs Batch)

The ID of the batch used to track COGS

entries[].datestring(Date)required

entries[].deferral_batch_idstring(Deferral Batch)

The ID of the batch used to process deferrals

entries[].deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entries[].entry_idstring(Entry)required

entries[].parent_entry_idstring(Parent Entry)

entries[].recognized_in_fiscal_periodnumber(float)(Recognized In Fiscal Period)[ 1 .. 23 ]

The fiscal period in which this entry was recognized

entries[].recognized_in_fiscal_year_idstring(Recognized In Fiscal Year)

The fiscal year in which this entry was recognized

entries[].revenue_gl_account_idstring(Revenue Gl Account)required

entries[].revenue_split_idstring(Revenue Split)

entries[].statusstring(Status)required

Enum"error""recognized""unrecognized"

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this revenue recognition schedule

invoice_idstring(Invoice)required

invoice_line_item_idstring(Invoice Line Item)required

membership_idstring(Membership)

The membership this schedule is tied to

notesstring(Notes)

Optional notes/description for the schedule

organization_idstring(Organization)

Organization that owns this

parent_schedule_idstring(Parent Schedule)

The parent schedule, if this schedule is related to another

payment_idstring(Payment)required

payment_line_item_idstring(Payment Line Item)required

product_idstring(Product)required

The ID of the product

product_namestring(Product Name)

The name of the product

product_typestring(Product Type)required

The type of product being deferred

product_versionnumber(float)(Product Version)

The versino of the product that created this schedule

recognized_amountnumber(float)(Recognized Amount)required

The amount of revenue that has been recognized

refund_idstring(Refund)required

revenue_gl_account_idstring(Revenue Gl Account)required

revenue_splitsArray of objects

statusstring(Status)required

Enum"closed""open"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_business_unit_statusstring(Sys Business Unit Status)

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

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(float)(Total)required

The total to be recognized in this schedule

transaction_idstring(Transaction)required

The transaction ID

typestring(Type)required

Enum"credit memo""debit memo""invoice""payment""refund""write off"

unrecognized_amountnumber(float)(Unrecognized Amount)required

The unrecognized amount of revenue

write_off_idstring(Write Off)required

Response

application/json

{
  "batch_id": "string",
  "business_unit_id": "string",
  "contact_id": "string",
  "credit_memo_id": "string",
  "currency_code": "str",
  "custom_field_values": [
    { … }
  ],
  "customer_type": "string",
  "date": "string",
  "debit_memo_id": "string",
  "deferred_revenue_gl_account_id": "string",
  "entries": [
    { … }
  ],
  "id": "string",
  "invoice_id": "string",
  "invoice_line_item_id": "string",
  "membership_id": "string",
  "notes": "string",
  "organization_id": "string",
  "parent_schedule_id": "string",
  "payment_id": "string",
  "payment_line_item_id": "string",
  "product_id": "string",
  "product_name": "string",
  "product_type": "string",
  "product_version": 0.1,
  "recognized_amount": 0.1,
  "refund_id": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "status": "closed",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_business_unit_status": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": 0.1,
  "transaction_id": "string",
  "type": "credit memo",
  "unrecognized_amount": 0.1,
  "write_off_id": "string"
}

Partially updates a revenue recognition schedule with the specified ID.

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the revenue recognition schedule to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The revenue recognition schedule was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

batch_idstring(Batch)required

The batch that posted the schedule

business_unit_idstring(Business Unit)required

The business unit this schedule belongs to

contact_idstring(Contact)

Contact that owns this

credit_memo_idstring(Credit Memo)required

currency_codestring(Currency Code)= 3 charactersrequired

The currency code for the revenue recognition schedule

custom_field_valuesArray of objects(Custom Field Values)

customer_typestring(Customer Type)

The type of customer that "owns" this schedule

datestring(Date)

debit_memo_idstring(Debit Memo)required

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

entries[].batch_idBatch (string)(Batch)

The batch that recognized this entry

One of:

The batch that recognized this entry

string(Batch)

entries[].cogs_batch_idstring(Cogs Batch)

The ID of the batch used to track COGS

entries[].datestring(Date)required

entries[].deferral_batch_idstring(Deferral Batch)

The ID of the batch used to process deferrals

entries[].deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entries[].entry_idstring(Entry)required

entries[].parent_entry_idstring(Parent Entry)

entries[].recognized_in_fiscal_periodnumber(float)(Recognized In Fiscal Period)[ 1 .. 23 ]

The fiscal period in which this entry was recognized

entries[].recognized_in_fiscal_year_idstring(Recognized In Fiscal Year)

The fiscal year in which this entry was recognized

entries[].revenue_gl_account_idstring(Revenue Gl Account)required

entries[].revenue_split_idstring(Revenue Split)

entries[].statusstring(Status)required

Enum"error""recognized""unrecognized"

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this revenue recognition schedule

invoice_idstring(Invoice)required

invoice_line_item_idstring(Invoice Line Item)required

membership_idstring(Membership)

The membership this schedule is tied to

notesstring(Notes)

Optional notes/description for the schedule

organization_idstring(Organization)

Organization that owns this

parent_schedule_idstring(Parent Schedule)

The parent schedule, if this schedule is related to another

payment_idstring(Payment)required

payment_line_item_idstring(Payment Line Item)required

product_idstring(Product)required

The ID of the product

product_namestring(Product Name)

The name of the product

product_typestring(Product Type)required

The type of product being deferred

product_versionnumber(float)(Product Version)

The versino of the product that created this schedule

recognized_amountnumber(float)(Recognized Amount)required

The amount of revenue that has been recognized

refund_idstring(Refund)required

revenue_gl_account_idstring(Revenue Gl Account)required

revenue_splitsArray of objects

statusstring(Status)required

Enum"closed""open"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_business_unit_statusstring(Sys Business Unit Status)

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

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(float)(Total)required

The total to be recognized in this schedule

transaction_idstring(Transaction)required

The transaction ID

typestring(Type)required

Enum"credit memo""debit memo""invoice""payment""refund""write off"

unrecognized_amountnumber(float)(Unrecognized Amount)required

The unrecognized amount of revenue

write_off_idstring(Write Off)required

Response

application/json

{
  "batch_id": "string",
  "business_unit_id": "string",
  "contact_id": "string",
  "credit_memo_id": "string",
  "currency_code": "str",
  "custom_field_values": [
    { … }
  ],
  "customer_type": "string",
  "date": "string",
  "debit_memo_id": "string",
  "deferred_revenue_gl_account_id": "string",
  "entries": [
    { … }
  ],
  "id": "string",
  "invoice_id": "string",
  "invoice_line_item_id": "string",
  "membership_id": "string",
  "notes": "string",
  "organization_id": "string",
  "parent_schedule_id": "string",
  "payment_id": "string",
  "payment_line_item_id": "string",
  "product_id": "string",
  "product_name": "string",
  "product_type": "string",
  "product_version": 0.1,
  "recognized_amount": 0.1,
  "refund_id": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "status": "closed",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_business_unit_status": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": 0.1,
  "transaction_id": "string",
  "type": "credit memo",
  "unrecognized_amount": 0.1,
  "write_off_id": "string"
}

Updates a revenue recognition schedule with the specified ID.

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the revenue recognition schedule to update.

Bodyapplication/jsonrequired

The updated revenue recognition schedule that will be saved.

batch_idstring(Batch)required

The batch that posted the schedule

business_unit_idstring(Business Unit)required

The business unit this schedule belongs to

contact_idstring(Contact)

Contact that owns this

credit_memo_idstring(Credit Memo)required

currency_codestring(Currency Code)= 3 charactersrequired

The currency code for the revenue recognition schedule

custom_field_valuesArray of objects(Custom Field Values)

customer_typestring(Customer Type)

The type of customer that "owns" this schedule

datestring(Date)

debit_memo_idstring(Debit Memo)required

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

entries[].batch_idBatch (string)(Batch)

The batch that recognized this entry

One of:

The batch that recognized this entry

string(Batch)

entries[].cogs_batch_idstring(Cogs Batch)

The ID of the batch used to track COGS

entries[].datestring(Date)required

entries[].deferral_batch_idstring(Deferral Batch)

The ID of the batch used to process deferrals

entries[].deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entries[].entry_idstring(Entry)required

entries[].parent_entry_idstring(Parent Entry)

entries[].recognized_in_fiscal_periodnumber(float)(Recognized In Fiscal Period)[ 1 .. 23 ]

The fiscal period in which this entry was recognized

entries[].recognized_in_fiscal_year_idstring(Recognized In Fiscal Year)

The fiscal year in which this entry was recognized

entries[].revenue_gl_account_idstring(Revenue Gl Account)required

entries[].revenue_split_idstring(Revenue Split)

entries[].statusstring(Status)required

Enum"error""recognized""unrecognized"

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this revenue recognition schedule

invoice_idstring(Invoice)required

invoice_line_item_idstring(Invoice Line Item)required

membership_idstring(Membership)

The membership this schedule is tied to

notesstring(Notes)

Optional notes/description for the schedule

organization_idstring(Organization)

Organization that owns this

parent_schedule_idstring(Parent Schedule)

The parent schedule, if this schedule is related to another

payment_idstring(Payment)required

payment_line_item_idstring(Payment Line Item)required

product_idstring(Product)required

The ID of the product

product_namestring(Product Name)

The name of the product

product_typestring(Product Type)required

The type of product being deferred

product_versionnumber(float)(Product Version)

The versino of the product that created this schedule

recognized_amountnumber(float)(Recognized Amount)required

The amount of revenue that has been recognized

refund_idstring(Refund)required

revenue_gl_account_idstring(Revenue Gl Account)required

revenue_splitsArray of objects

statusstring(Status)required

Enum"closed""open"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_business_unit_statusstring(Sys Business Unit Status)

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

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(float)(Total)required

The total to be recognized in this schedule

transaction_idstring(Transaction)required

The transaction ID

typestring(Type)required

Enum"credit memo""debit memo""invoice""payment""refund""write off"

unrecognized_amountnumber(float)(Unrecognized Amount)required

The unrecognized amount of revenue

write_off_idstring(Write Off)required

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/revenueRecognitionSchedules/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batch_id": "string",
    "business_unit_id": "string",
    "contact_id": "string",
    "credit_memo_id": "string",
    "currency_code": "str",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "customer_type": "string",
    "date": "string",
    "debit_memo_id": "string",
    "deferred_revenue_gl_account_id": "string",
    "entries": [
      {
        "amount": 0.1,
        "batch_id": null,
        "cogs_batch_id": "string",
        "date": "string",
        "deferral_batch_id": "string",
        "deferred_revenue_gl_account_id": "string",
        "entry_id": "string",
        "parent_entry_id": "string",
        "recognized_in_fiscal_period": 1,
        "recognized_in_fiscal_year_id": "string",
        "revenue_gl_account_id": "string",
        "revenue_split_id": "string",
        "status": "error"
      }
    ],
    "id": "string",
    "invoice_id": "string",
    "invoice_line_item_id": "string",
    "membership_id": "string",
    "notes": "string",
    "organization_id": "string",
    "parent_schedule_id": "string",
    "payment_id": "string",
    "payment_line_item_id": "string",
    "product_id": "string",
    "product_name": "string",
    "product_type": "string",
    "product_version": 0.1,
    "recognized_amount": 0.1,
    "refund_id": "string",
    "revenue_gl_account_id": "string",
    "revenue_splits": [
      {
        "amount": null,
        "percentage": null,
        "revenue_gl_account_id": "string",
        "revenue_split_id": "string",
        "type": "fixed amount"
      }
    ],
    "status": "closed",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_business_unit_status": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": 0.1,
    "transaction_id": "string",
    "type": "credit memo",
    "unrecognized_amount": 0.1,
    "write_off_id": "string"
  }'

Responses

The revenue recognition schedule was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

batch_idstring(Batch)required

The batch that posted the schedule

business_unit_idstring(Business Unit)required

The business unit this schedule belongs to

contact_idstring(Contact)

Contact that owns this

credit_memo_idstring(Credit Memo)required

currency_codestring(Currency Code)= 3 charactersrequired

The currency code for the revenue recognition schedule

custom_field_valuesArray of objects(Custom Field Values)

customer_typestring(Customer Type)

The type of customer that "owns" this schedule

datestring(Date)

debit_memo_idstring(Debit Memo)required

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

entries[].batch_idBatch (string)(Batch)

The batch that recognized this entry

One of:

The batch that recognized this entry

string(Batch)

entries[].cogs_batch_idstring(Cogs Batch)

The ID of the batch used to track COGS

entries[].datestring(Date)required

entries[].deferral_batch_idstring(Deferral Batch)

The ID of the batch used to process deferrals

entries[].deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

entries[].entry_idstring(Entry)required

entries[].parent_entry_idstring(Parent Entry)

entries[].recognized_in_fiscal_periodnumber(float)(Recognized In Fiscal Period)[ 1 .. 23 ]

The fiscal period in which this entry was recognized

entries[].recognized_in_fiscal_year_idstring(Recognized In Fiscal Year)

The fiscal year in which this entry was recognized

entries[].revenue_gl_account_idstring(Revenue Gl Account)required

entries[].revenue_split_idstring(Revenue Split)

entries[].statusstring(Status)required

Enum"error""recognized""unrecognized"

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this revenue recognition schedule

invoice_idstring(Invoice)required

invoice_line_item_idstring(Invoice Line Item)required

membership_idstring(Membership)

The membership this schedule is tied to

notesstring(Notes)

Optional notes/description for the schedule

organization_idstring(Organization)

Organization that owns this

parent_schedule_idstring(Parent Schedule)

The parent schedule, if this schedule is related to another

payment_idstring(Payment)required

payment_line_item_idstring(Payment Line Item)required

product_idstring(Product)required

The ID of the product

product_namestring(Product Name)

The name of the product

product_typestring(Product Type)required

The type of product being deferred

product_versionnumber(float)(Product Version)

The versino of the product that created this schedule

recognized_amountnumber(float)(Recognized Amount)required

The amount of revenue that has been recognized

refund_idstring(Refund)required

revenue_gl_account_idstring(Revenue Gl Account)required

revenue_splitsArray of objects

statusstring(Status)required

Enum"closed""open"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_business_unit_statusstring(Sys Business Unit Status)

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

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(float)(Total)required

The total to be recognized in this schedule

transaction_idstring(Transaction)required

The transaction ID

typestring(Type)required

Enum"credit memo""debit memo""invoice""payment""refund""write off"

unrecognized_amountnumber(float)(Unrecognized Amount)required

The unrecognized amount of revenue

write_off_idstring(Write Off)required

Response

application/json

{
  "batch_id": "string",
  "business_unit_id": "string",
  "contact_id": "string",
  "credit_memo_id": "string",
  "currency_code": "str",
  "custom_field_values": [
    { … }
  ],
  "customer_type": "string",
  "date": "string",
  "debit_memo_id": "string",
  "deferred_revenue_gl_account_id": "string",
  "entries": [
    { … }
  ],
  "id": "string",
  "invoice_id": "string",
  "invoice_line_item_id": "string",
  "membership_id": "string",
  "notes": "string",
  "organization_id": "string",
  "parent_schedule_id": "string",
  "payment_id": "string",
  "payment_line_item_id": "string",
  "product_id": "string",
  "product_name": "string",
  "product_type": "string",
  "product_version": 0.1,
  "recognized_amount": 0.1,
  "refund_id": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "status": "closed",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_business_unit_status": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": 0.1,
  "transaction_id": "string",
  "type": "credit memo",
  "unrecognized_amount": 0.1,
  "write_off_id": "string"
}

Settings

Operations

Statement Templates

Operations

Statements

Operations

Statistics

Operations

Stored Payment Methods

Operations

Subledger Entries

Operations

Write Offs

Operations

Accounting Projects

Bank Accounts

Batch Assignment Settings

Batch Downloading

Batch Posting

Batch Templates

Batches

Billing Notices

Billing Run Actions

Billing Runs

Billing Templates

Business Units

Check Request Processes

Check Request Templates

Check Requests

Cogs Entries

Credit Memos

Credits

Currency Mapping Policies

Debit Memos

Departments

Donation Products

Exchange Rates

External Payments

Fiscal Years

Gateway Entities

Gateway Entries

Gateway Fees

Gl Accounts

Installment Plans

Installment Schedules

Invoice Payment Terms

Invoice Templates

Invoice Types

Invoices

Late Fee Rules

Late Fees

Legacy Import Products

Merchant Accounts

Miscellaneous Products

Payment Receipt Templates

Payments

Product Financial Configs

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Refunds

Revenue Recognition Schedules

Gets all of the revenue recognition schedules in the system.

Request

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified batch_id

Request

Responses

Was this helpful?

Returns a list of OPEN records with the specified business_unit_id

Request

Responses

Was this helpful?

Returns a list of records with the specified credit_memo_id

Request

Responses

Was this helpful?

Returns a list of records with the specified debit_memo_id

Request

Responses

Was this helpful?

Returns a list of records with the specified invoice_id

Request

Responses

Was this helpful?

Returns a list of records with the specified membership_id

Request

Responses

Request

Request