Batches

Accounting Projects

Operations

Bank Accounts

Operations

Batch Assignment Settings

Operations

Batch Downloading

Operations

Batch Posting

Operations

Batch Templates

Operations

Batches

Operations

Gets all of the batches in the system.

Request

This method will scan all batches 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/batches/{tenantId}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The batcheswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

automatically_close_atstring(date-time)(Automatically Close At)

Date/time at which this batch should automatically close

business_unit_idstring(Business Unit)required

The business unit that the batch belongs in

closed_atstring(date-time)(Closed At)

Date the batch was closed

countnumber(float)(Count)

The total # of payments + refunds

currency_codestring(Currency Code)= 3 characters

The currency code in use

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)required

The date of the batch

dependentsArray of strings(Dependents)

List of batches that depend on this one

descriptionstring(Description)

Descriptive notes about the batch

downloaded_atstring(date-time)(Downloaded At)

Date the batch was downloaded

downloading_workflow_execution_idstring(Downloading Workflow Execution)

The ID of the state machine execution that last downloaded this batch

errorsArray of objects

fiscal_periodinteger(Fiscal Period)[ 1 .. 12 ]required

The fiscal period of the batch

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the business unit

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

The unique, string identifier of this batch

namestring(Name)required

The name of the batch

posted_atstring(date-time)(Posted At)

The date the batch was posted

posting_workflow_execution_idstring(Posting Workflow Execution)

The ID of the state machine execution that posted this batch

recurring_batch_idstring(Recurring Batch)

The recurring batch definition that this batch is tied to

statisticsobject(Statistics)

statusstring(Status)

Enum"archived""closed""downloaded""error""open""posted""posting""verified"

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_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_composite_fiscal_period_keystring(Sys Composite Fiscal Period Key)

Internal use

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_fiscal_period_idstring(Sys Fiscal Period)

Concatenation of the fiscal year and fiscal period

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(double)(Total)

The total amount of payments - refunds for the batch

typestring(Type)

Type of batch

Enum"cost of goods sold""deferred revenue""legacy""transaction"

unposting_workflow_execution_idstring(Unposting Workflow Execution)

The ID of the state machine execution that last unposted this batch

]

Response

application/json

[
  {
    "automatically_close_at": "2019-08-24T14:15:22Z",
    "business_unit_id": "string",
    "closed_at": "2019-08-24T14:15:22Z",
    "count": 0.1,
    "currency_code": "str",
    "currency_symbol": "string",
    "custom_field_values": [ … ],
    "date": "2019-08-24",
    "dependents": [ … ],
    "description": "string",
    "downloaded_at": "2019-08-24T14:15:22Z",
    "downloading_workflow_execution_id": "string",
    "errors": [ … ],
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": "string",
    "name": "string",
    "posted_at": "2019-08-24T14:15:22Z",
    "posting_workflow_execution_id": "string",
    "recurring_batch_id": "string",
    "statistics": { … },
    "status": "archived",
    "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_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_composite_fiscal_period_key": "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_fiscal_period_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,
    "type": "cost of goods sold",
    "unposting_workflow_execution_id": "string"
  }
]

Creates a new batch record that does not already exist.

Request

This method will auto-generate an ID and create a new batch. If an ID is specified for the batch, an error will be thrown.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch that you would like to be saved.

automatically_close_atstring(date-time)(Automatically Close At)

Date/time at which this batch should automatically close

business_unit_idstring(Business Unit)required

The business unit that the batch belongs in

closed_atstring(date-time)(Closed At)

Date the batch was closed

countnumber(float)(Count)

The total # of payments + refunds

currency_codestring(Currency Code)= 3 characters

The currency code in use

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)required

The date of the batch

dependentsArray of strings(Dependents)

List of batches that depend on this one

descriptionstring(Description)

Descriptive notes about the batch

downloaded_atstring(date-time)(Downloaded At)

Date the batch was downloaded

downloading_workflow_execution_idstring(Downloading Workflow Execution)

The ID of the state machine execution that last downloaded this batch

errorsArray of objects

fiscal_periodinteger(Fiscal Period)[ 1 .. 12 ]required

The fiscal period of the batch

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the business unit

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

The unique, string identifier of this batch

namestring(Name)required

The name of the batch

posted_atstring(date-time)(Posted At)

The date the batch was posted

posting_workflow_execution_idstring(Posting Workflow Execution)

The ID of the state machine execution that posted this batch

recurring_batch_idstring(Recurring Batch)

The recurring batch definition that this batch is tied to

statisticsobject(Statistics)

statusstring(Status)

Enum"archived""closed""downloaded""error""open""posted""posting""verified"

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_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_composite_fiscal_period_keystring(Sys Composite Fiscal Period Key)

Internal use

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_fiscal_period_idstring(Sys Fiscal Period)

Concatenation of the fiscal year and fiscal period

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(double)(Total)

The total amount of payments - refunds for the batch

typestring(Type)

Type of batch

Enum"cost of goods sold""deferred revenue""legacy""transaction"

unposting_workflow_execution_idstring(Unposting Workflow Execution)

The ID of the state machine execution that last unposted this batch

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batches/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "automatically_close_at": "2019-08-24T14:15:22Z",
    "business_unit_id": "string",
    "closed_at": "2019-08-24T14:15:22Z",
    "count": 0.1,
    "currency_code": "str",
    "currency_symbol": "string",
    "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": [
          {}
        ]
      }
    ],
    "date": "2019-08-24",
    "dependents": [
      "string"
    ],
    "description": "string",
    "downloaded_at": "2019-08-24T14:15:22Z",
    "downloading_workflow_execution_id": "string",
    "errors": [
      {
        "error_message": "string",
        "transaction_id": "string",
        "transaction_type": "string"
      }
    ],
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": "string",
    "name": "string",
    "posted_at": "2019-08-24T14:15:22Z",
    "posting_workflow_execution_id": "string",
    "recurring_batch_id": "string",
    "statistics": {
      "credit_memo_total": 0.1,
      "credit_total": 0.1,
      "debit_memo_total": 0.1,
      "invoice_total": 0.1,
      "number_of_credit_memos": 0.1,
      "number_of_credits": 0.1,
      "number_of_debit_memos": 0.1,
      "number_of_invoices": 0.1,
      "number_of_payments": 0.1,
      "number_of_refunds": 0.1,
      "number_of_write_offs": 0.1,
      "payment_total": 0.1,
      "refund_total": 0.1,
      "write_off_total": 0.1
    },
    "status": "archived",
    "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_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_composite_fiscal_period_key": "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_fiscal_period_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,
    "type": "cost of goods sold",
    "unposting_workflow_execution_id": "string"
  }'

Responses

The batch was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

automatically_close_atstring(date-time)(Automatically Close At)

Date/time at which this batch should automatically close

business_unit_idstring(Business Unit)required

The business unit that the batch belongs in

closed_atstring(date-time)(Closed At)

Date the batch was closed

countnumber(float)(Count)

The total # of payments + refunds

currency_codestring(Currency Code)= 3 characters

The currency code in use

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)required

The date of the batch

dependentsArray of strings(Dependents)

List of batches that depend on this one

descriptionstring(Description)

Descriptive notes about the batch

downloaded_atstring(date-time)(Downloaded At)

Date the batch was downloaded

downloading_workflow_execution_idstring(Downloading Workflow Execution)

The ID of the state machine execution that last downloaded this batch

errorsArray of objects

fiscal_periodinteger(Fiscal Period)[ 1 .. 12 ]required

The fiscal period of the batch

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the business unit

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

The unique, string identifier of this batch

namestring(Name)required

The name of the batch

posted_atstring(date-time)(Posted At)

The date the batch was posted

posting_workflow_execution_idstring(Posting Workflow Execution)

The ID of the state machine execution that posted this batch

recurring_batch_idstring(Recurring Batch)

The recurring batch definition that this batch is tied to

statisticsobject(Statistics)

statusstring(Status)

Enum"archived""closed""downloaded""error""open""posted""posting""verified"

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_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_composite_fiscal_period_keystring(Sys Composite Fiscal Period Key)

Internal use

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_fiscal_period_idstring(Sys Fiscal Period)

Concatenation of the fiscal year and fiscal period

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(double)(Total)

The total amount of payments - refunds for the batch

typestring(Type)

Type of batch

Enum"cost of goods sold""deferred revenue""legacy""transaction"

unposting_workflow_execution_idstring(Unposting Workflow Execution)

The ID of the state machine execution that last unposted this batch

Response

application/json

{
  "automatically_close_at": "2019-08-24T14:15:22Z",
  "business_unit_id": "string",
  "closed_at": "2019-08-24T14:15:22Z",
  "count": 0.1,
  "currency_code": "str",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "dependents": [
    "string"
  ],
  "description": "string",
  "downloaded_at": "2019-08-24T14:15:22Z",
  "downloading_workflow_execution_id": "string",
  "errors": [
    { … }
  ],
  "fiscal_period": 1,
  "fiscal_year_id": "string",
  "id": "string",
  "name": "string",
  "posted_at": "2019-08-24T14:15:22Z",
  "posting_workflow_execution_id": "string",
  "recurring_batch_id": "string",
  "statistics": {
    "credit_memo_total": 0.1,
    "credit_total": 0.1,
    "debit_memo_total": 0.1,
    "invoice_total": 0.1,
    "number_of_credit_memos": 0.1,
    "number_of_credits": 0.1,
    "number_of_debit_memos": 0.1,
    "number_of_invoices": 0.1,
    "number_of_payments": 0.1,
    "number_of_refunds": 0.1,
    "number_of_write_offs": 0.1,
    "payment_total": 0.1,
    "refund_total": 0.1,
    "write_off_total": 0.1
  },
  "status": "archived",
  "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_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_composite_fiscal_period_key": "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_fiscal_period_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,
  "type": "cost of goods sold",
  "unposting_workflow_execution_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/batches/{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
}

Recursively retrieve batches dependent on a set of batches

Request

Returns a list of child batches dependent on the batches specified

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

Query

idsstringrequired

The batch IDs

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batches/{tenantId}/dependents?ids=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

childrenArray of strings(Children)non-emptyrequired

Response

application/json

{
  "children": [
    "string"
  ]
}

Returns a list of records with the specified fiscal_year_id and fiscal_period

Request

Returns a list of records with the specified fiscal_year_id and fiscal_period

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

fiscal_year_idstringrequired

The fiscal_year_id to use to for record lookup

fiscal_periodstringrequired

The fiscal_period to use to for record lookup

Query

fieldsstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batches/{tenantId}/fiscal_period/{fiscal_year_id}/{fiscal_period}?fields=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(Batch)

LastEvaluatedKeystring

Response

application/json

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

Searches for batches using predefined parameters

Request

Searches for batches using predefined parameters

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The batch that you would like to be saved.

business_unit_idstring(Business Unit)

countArray of strings(Count)= 2 items

dateArray of strings(Date)= 2 items

fiscal_periodnumber(float)(Fiscal Period)[ 1 .. 12 ]

fiscal_year_idstring(Fiscal Year)

idArray of strings(ID)

namestring(Name)

recurring_batch_idArray of strings(Recurring Batch)

statusArray of strings(Status)

Items Enum"closed""downloaded""error""open""posted""posting""verified"

totalArray of strings(Total)= 2 items

typeArray of strings(Type)

Items Enum"cost of goods sold""deferred revenue""transaction"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batches/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "business_unit_id": "string",
    "count": [
      "string",
      "string"
    ],
    "date": [
      "string",
      "string"
    ],
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": [
      "string"
    ],
    "name": "string",
    "recurring_batch_id": [
      "string"
    ],
    "status": [
      "closed"
    ],
    "total": [
      "string",
      "string"
    ],
    "type": [
      "cost of goods sold"
    ]
  }'

Responses

The batch search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(BatchSearchResults)

LastEvaluatedKeystring

Response

application/json

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

Returns a list of records with the specified status

Request

Returns a list of records with the specified status

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

businessUnitIdstringrequired

The business unt

statusstringrequired

The status to use to for record lookup

Query

fieldsstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batches/{tenantId}/status/{status}/{businessUnitId}?fields=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(Batch)

LastEvaluatedKeystring

Response

application/json

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

Returns a batch from the system by its ID.

Request

This method will delete a batch with the specified ID.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the batch to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batches/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The batch was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a batch from the system by its ID.

Request

This method will look up a batch 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 batch 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/batches/{tenantId}/{id}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The batch was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

automatically_close_atstring(date-time)(Automatically Close At)

Date/time at which this batch should automatically close

business_unit_idstring(Business Unit)required

The business unit that the batch belongs in

closed_atstring(date-time)(Closed At)

Date the batch was closed

countnumber(float)(Count)

The total # of payments + refunds

currency_codestring(Currency Code)= 3 characters

The currency code in use

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)required

The date of the batch

dependentsArray of strings(Dependents)

List of batches that depend on this one

descriptionstring(Description)

Descriptive notes about the batch

downloaded_atstring(date-time)(Downloaded At)

Date the batch was downloaded

downloading_workflow_execution_idstring(Downloading Workflow Execution)

The ID of the state machine execution that last downloaded this batch

errorsArray of objects

fiscal_periodinteger(Fiscal Period)[ 1 .. 12 ]required

The fiscal period of the batch

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the business unit

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

The unique, string identifier of this batch

namestring(Name)required

The name of the batch

posted_atstring(date-time)(Posted At)

The date the batch was posted

posting_workflow_execution_idstring(Posting Workflow Execution)

The ID of the state machine execution that posted this batch

recurring_batch_idstring(Recurring Batch)

The recurring batch definition that this batch is tied to

statisticsobject(Statistics)

statusstring(Status)

Enum"archived""closed""downloaded""error""open""posted""posting""verified"

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_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_composite_fiscal_period_keystring(Sys Composite Fiscal Period Key)

Internal use

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_fiscal_period_idstring(Sys Fiscal Period)

Concatenation of the fiscal year and fiscal period

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(double)(Total)

The total amount of payments - refunds for the batch

typestring(Type)

Type of batch

Enum"cost of goods sold""deferred revenue""legacy""transaction"

unposting_workflow_execution_idstring(Unposting Workflow Execution)

The ID of the state machine execution that last unposted this batch

Response

application/json

{
  "automatically_close_at": "2019-08-24T14:15:22Z",
  "business_unit_id": "string",
  "closed_at": "2019-08-24T14:15:22Z",
  "count": 0.1,
  "currency_code": "str",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "dependents": [
    "string"
  ],
  "description": "string",
  "downloaded_at": "2019-08-24T14:15:22Z",
  "downloading_workflow_execution_id": "string",
  "errors": [
    { … }
  ],
  "fiscal_period": 1,
  "fiscal_year_id": "string",
  "id": "string",
  "name": "string",
  "posted_at": "2019-08-24T14:15:22Z",
  "posting_workflow_execution_id": "string",
  "recurring_batch_id": "string",
  "statistics": {
    "credit_memo_total": 0.1,
    "credit_total": 0.1,
    "debit_memo_total": 0.1,
    "invoice_total": 0.1,
    "number_of_credit_memos": 0.1,
    "number_of_credits": 0.1,
    "number_of_debit_memos": 0.1,
    "number_of_invoices": 0.1,
    "number_of_payments": 0.1,
    "number_of_refunds": 0.1,
    "number_of_write_offs": 0.1,
    "payment_total": 0.1,
    "refund_total": 0.1,
    "write_off_total": 0.1
  },
  "status": "archived",
  "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_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_composite_fiscal_period_key": "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_fiscal_period_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,
  "type": "cost of goods sold",
  "unposting_workflow_execution_id": "string"
}

Partially updates a batch with the specified ID.

Request

This method will patch an existing batch 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 batch 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/batches/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The batch was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

automatically_close_atstring(date-time)(Automatically Close At)

Date/time at which this batch should automatically close

business_unit_idstring(Business Unit)required

The business unit that the batch belongs in

closed_atstring(date-time)(Closed At)

Date the batch was closed

countnumber(float)(Count)

The total # of payments + refunds

currency_codestring(Currency Code)= 3 characters

The currency code in use

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)required

The date of the batch

dependentsArray of strings(Dependents)

List of batches that depend on this one

descriptionstring(Description)

Descriptive notes about the batch

downloaded_atstring(date-time)(Downloaded At)

Date the batch was downloaded

downloading_workflow_execution_idstring(Downloading Workflow Execution)

The ID of the state machine execution that last downloaded this batch

errorsArray of objects

fiscal_periodinteger(Fiscal Period)[ 1 .. 12 ]required

The fiscal period of the batch

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the business unit

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

The unique, string identifier of this batch

namestring(Name)required

The name of the batch

posted_atstring(date-time)(Posted At)

The date the batch was posted

posting_workflow_execution_idstring(Posting Workflow Execution)

The ID of the state machine execution that posted this batch

recurring_batch_idstring(Recurring Batch)

The recurring batch definition that this batch is tied to

statisticsobject(Statistics)

statusstring(Status)

Enum"archived""closed""downloaded""error""open""posted""posting""verified"

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_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_composite_fiscal_period_keystring(Sys Composite Fiscal Period Key)

Internal use

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_fiscal_period_idstring(Sys Fiscal Period)

Concatenation of the fiscal year and fiscal period

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(double)(Total)

The total amount of payments - refunds for the batch

typestring(Type)

Type of batch

Enum"cost of goods sold""deferred revenue""legacy""transaction"

unposting_workflow_execution_idstring(Unposting Workflow Execution)

The ID of the state machine execution that last unposted this batch

Response

application/json

{
  "automatically_close_at": "2019-08-24T14:15:22Z",
  "business_unit_id": "string",
  "closed_at": "2019-08-24T14:15:22Z",
  "count": 0.1,
  "currency_code": "str",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "dependents": [
    "string"
  ],
  "description": "string",
  "downloaded_at": "2019-08-24T14:15:22Z",
  "downloading_workflow_execution_id": "string",
  "errors": [
    { … }
  ],
  "fiscal_period": 1,
  "fiscal_year_id": "string",
  "id": "string",
  "name": "string",
  "posted_at": "2019-08-24T14:15:22Z",
  "posting_workflow_execution_id": "string",
  "recurring_batch_id": "string",
  "statistics": {
    "credit_memo_total": 0.1,
    "credit_total": 0.1,
    "debit_memo_total": 0.1,
    "invoice_total": 0.1,
    "number_of_credit_memos": 0.1,
    "number_of_credits": 0.1,
    "number_of_debit_memos": 0.1,
    "number_of_invoices": 0.1,
    "number_of_payments": 0.1,
    "number_of_refunds": 0.1,
    "number_of_write_offs": 0.1,
    "payment_total": 0.1,
    "refund_total": 0.1,
    "write_off_total": 0.1
  },
  "status": "archived",
  "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_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_composite_fiscal_period_key": "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_fiscal_period_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,
  "type": "cost of goods sold",
  "unposting_workflow_execution_id": "string"
}

Updates a batch with the specified ID.

Request

This method will update an existing batch with the specified ID.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the batch to update.

Bodyapplication/jsonrequired

The updated batch that will be saved.

automatically_close_atstring(date-time)(Automatically Close At)

Date/time at which this batch should automatically close

business_unit_idstring(Business Unit)required

The business unit that the batch belongs in

closed_atstring(date-time)(Closed At)

Date the batch was closed

countnumber(float)(Count)

The total # of payments + refunds

currency_codestring(Currency Code)= 3 characters

The currency code in use

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)required

The date of the batch

dependentsArray of strings(Dependents)

List of batches that depend on this one

descriptionstring(Description)

Descriptive notes about the batch

downloaded_atstring(date-time)(Downloaded At)

Date the batch was downloaded

downloading_workflow_execution_idstring(Downloading Workflow Execution)

The ID of the state machine execution that last downloaded this batch

errorsArray of objects

fiscal_periodinteger(Fiscal Period)[ 1 .. 12 ]required

The fiscal period of the batch

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the business unit

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

The unique, string identifier of this batch

namestring(Name)required

The name of the batch

posted_atstring(date-time)(Posted At)

The date the batch was posted

posting_workflow_execution_idstring(Posting Workflow Execution)

The ID of the state machine execution that posted this batch

recurring_batch_idstring(Recurring Batch)

The recurring batch definition that this batch is tied to

statisticsobject(Statistics)

statusstring(Status)

Enum"archived""closed""downloaded""error""open""posted""posting""verified"

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_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_composite_fiscal_period_keystring(Sys Composite Fiscal Period Key)

Internal use

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_fiscal_period_idstring(Sys Fiscal Period)

Concatenation of the fiscal year and fiscal period

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(double)(Total)

The total amount of payments - refunds for the batch

typestring(Type)

Type of batch

Enum"cost of goods sold""deferred revenue""legacy""transaction"

unposting_workflow_execution_idstring(Unposting Workflow Execution)

The ID of the state machine execution that last unposted this batch

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/batches/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "automatically_close_at": "2019-08-24T14:15:22Z",
    "business_unit_id": "string",
    "closed_at": "2019-08-24T14:15:22Z",
    "count": 0.1,
    "currency_code": "str",
    "currency_symbol": "string",
    "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": [
          {}
        ]
      }
    ],
    "date": "2019-08-24",
    "dependents": [
      "string"
    ],
    "description": "string",
    "downloaded_at": "2019-08-24T14:15:22Z",
    "downloading_workflow_execution_id": "string",
    "errors": [
      {
        "error_message": "string",
        "transaction_id": "string",
        "transaction_type": "string"
      }
    ],
    "fiscal_period": 1,
    "fiscal_year_id": "string",
    "id": "string",
    "name": "string",
    "posted_at": "2019-08-24T14:15:22Z",
    "posting_workflow_execution_id": "string",
    "recurring_batch_id": "string",
    "statistics": {
      "credit_memo_total": 0.1,
      "credit_total": 0.1,
      "debit_memo_total": 0.1,
      "invoice_total": 0.1,
      "number_of_credit_memos": 0.1,
      "number_of_credits": 0.1,
      "number_of_debit_memos": 0.1,
      "number_of_invoices": 0.1,
      "number_of_payments": 0.1,
      "number_of_refunds": 0.1,
      "number_of_write_offs": 0.1,
      "payment_total": 0.1,
      "refund_total": 0.1,
      "write_off_total": 0.1
    },
    "status": "archived",
    "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_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_composite_fiscal_period_key": "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_fiscal_period_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,
    "type": "cost of goods sold",
    "unposting_workflow_execution_id": "string"
  }'

Responses

The batch was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

automatically_close_atstring(date-time)(Automatically Close At)

Date/time at which this batch should automatically close

business_unit_idstring(Business Unit)required

The business unit that the batch belongs in

closed_atstring(date-time)(Closed At)

Date the batch was closed

countnumber(float)(Count)

The total # of payments + refunds

currency_codestring(Currency Code)= 3 characters

The currency code in use

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)required

The date of the batch

dependentsArray of strings(Dependents)

List of batches that depend on this one

descriptionstring(Description)

Descriptive notes about the batch

downloaded_atstring(date-time)(Downloaded At)

Date the batch was downloaded

downloading_workflow_execution_idstring(Downloading Workflow Execution)

The ID of the state machine execution that last downloaded this batch

errorsArray of objects

fiscal_periodinteger(Fiscal Period)[ 1 .. 12 ]required

The fiscal period of the batch

fiscal_year_idstring(Fiscal Year)required

The fiscal year of the business unit

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

The unique, string identifier of this batch

namestring(Name)required

The name of the batch

posted_atstring(date-time)(Posted At)

The date the batch was posted

posting_workflow_execution_idstring(Posting Workflow Execution)

The ID of the state machine execution that posted this batch

recurring_batch_idstring(Recurring Batch)

The recurring batch definition that this batch is tied to

statisticsobject(Statistics)

statusstring(Status)

Enum"archived""closed""downloaded""error""open""posted""posting""verified"

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_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_composite_fiscal_period_keystring(Sys Composite Fiscal Period Key)

Internal use

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_fiscal_period_idstring(Sys Fiscal Period)

Concatenation of the fiscal year and fiscal period

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(double)(Total)

The total amount of payments - refunds for the batch

typestring(Type)

Type of batch

Enum"cost of goods sold""deferred revenue""legacy""transaction"

unposting_workflow_execution_idstring(Unposting Workflow Execution)

The ID of the state machine execution that last unposted this batch

Response

application/json

{
  "automatically_close_at": "2019-08-24T14:15:22Z",
  "business_unit_id": "string",
  "closed_at": "2019-08-24T14:15:22Z",
  "count": 0.1,
  "currency_code": "str",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "dependents": [
    "string"
  ],
  "description": "string",
  "downloaded_at": "2019-08-24T14:15:22Z",
  "downloading_workflow_execution_id": "string",
  "errors": [
    { … }
  ],
  "fiscal_period": 1,
  "fiscal_year_id": "string",
  "id": "string",
  "name": "string",
  "posted_at": "2019-08-24T14:15:22Z",
  "posting_workflow_execution_id": "string",
  "recurring_batch_id": "string",
  "statistics": {
    "credit_memo_total": 0.1,
    "credit_total": 0.1,
    "debit_memo_total": 0.1,
    "invoice_total": 0.1,
    "number_of_credit_memos": 0.1,
    "number_of_credits": 0.1,
    "number_of_debit_memos": 0.1,
    "number_of_invoices": 0.1,
    "number_of_payments": 0.1,
    "number_of_refunds": 0.1,
    "number_of_write_offs": 0.1,
    "payment_total": 0.1,
    "refund_total": 0.1,
    "write_off_total": 0.1
  },
  "status": "archived",
  "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_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_composite_fiscal_period_key": "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_fiscal_period_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,
  "type": "cost of goods sold",
  "unposting_workflow_execution_id": "string"
}

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

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

Gets all of the batches in the system.

Request

Responses

Was this helpful?

Creates a new batch record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Recursively retrieve batches dependent on a set of batches

Request

Responses

Was this helpful?

Returns a list of records with the specified fiscal_year_id and fiscal_period

Request

Responses

Was this helpful?

Searches for batches using predefined parameters

Request

Responses

Was this helpful?

Returns a list of records with the specified status

Request

Responses

Was this helpful?

Returns a batch from the system by its ID.

Request

Responses

Was this helpful?

Returns a batch from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a batch with the specified ID.

Request

Responses

Was this helpful?

Updates a batch with the specified ID.

RequestExpand all

Responses

Was this helpful?

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

Request

Request

Request