Batches

Creates a new batch record that does not already exist.

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.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch that you would like to be saved.

id required	string (ID) /[\w\|-]+/ The unique, string identifier of this batch
name required	string (Name) The name of the batch
description	string (Description) Descriptive notes about the batch
	Array of objects
currency_code	string (Currency Code) 3 characters The currency code in use
currency_symbol	string (Currency Symbol) The currency symbol
business_unit_id required	string (Business Unit) The business unit that the batch belongs in
fiscal_year_id required	string (Fiscal Year) The fiscal year of the business unit
fiscal_period required	integer (Fiscal Period) [ 1 .. 12 ] The fiscal period of the batch
date required	string <date> (Date) The date of the batch
posted_at	string <date-time> (Posted At) The date the batch was posted
status	string (Status) Enum: "open" "closed" "verified" "posting" "posted" "downloaded" "error" "archived"
closed_at	string <date-time> (Closed At) Date the batch was closed
downloaded_at	string <date-time> (Downloaded At) Date the batch was downloaded
type	string (Type) Type of batch Enum: "transaction" "deferred revenue" "cost of goods sold" "legacy"
automatically_close_at	string <date-time> (Automatically Close At) Date/time at which this batch should automatically close
recurring_batch_id	string (Recurring Batch) The recurring batch definition that this batch is tied to
posting_workflow_execution_id	string (Posting Workflow Execution) The ID of the state machine execution that posted this batch
unposting_workflow_execution_id	string (Unposting Workflow Execution) The ID of the state machine execution that last unposted this batch
downloading_workflow_execution_id	string (Downloading Workflow Execution) The ID of the state machine execution that last downloaded this batch
dependents	Array of strings (Dependents) List of batches that depend on this one
total	number <double> (Total) The total amount of payments - refunds for the batch
count	number <float> (Count) The total # of payments + refunds
	object (Statistics)
sys_fiscal_period_id	string (Sys Fiscal Period) Concatenation of the fiscal year and fiscal period
sys_composite_fiscal_period_key	string (Sys Composite Fiscal Period Key) Internal use
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The batch was saved successfully.

400The batch you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The batch could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add batch based on tenant limits.

500General server error.

post/batches/{tenantId}

Request samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Gets all of the batches in the system.

This method will scan all batches and and return them to the caller.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The batcheswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/batches/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/batches/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
]

Returns a batch from the system by its ID.

This method will look up a batch by the specified ID and return it back.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the batch to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The batch was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The batch could not be found.

429Limit exceeded... unable to retrieve batch based on tenant limits.

500General server error.

get/batches/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/batches/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a batch with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the batch to update.

Request Body schema: application/json

The updated batch that will be saved.

id required	string (ID) /[\w\|-]+/ The unique, string identifier of this batch
name required	string (Name) The name of the batch
description	string (Description) Descriptive notes about the batch
	Array of objects
currency_code	string (Currency Code) 3 characters The currency code in use
currency_symbol	string (Currency Symbol) The currency symbol
business_unit_id required	string (Business Unit) The business unit that the batch belongs in
fiscal_year_id required	string (Fiscal Year) The fiscal year of the business unit
fiscal_period required	integer (Fiscal Period) [ 1 .. 12 ] The fiscal period of the batch
date required	string <date> (Date) The date of the batch
posted_at	string <date-time> (Posted At) The date the batch was posted
status	string (Status) Enum: "open" "closed" "verified" "posting" "posted" "downloaded" "error" "archived"
closed_at	string <date-time> (Closed At) Date the batch was closed
downloaded_at	string <date-time> (Downloaded At) Date the batch was downloaded
type	string (Type) Type of batch Enum: "transaction" "deferred revenue" "cost of goods sold" "legacy"
automatically_close_at	string <date-time> (Automatically Close At) Date/time at which this batch should automatically close
recurring_batch_id	string (Recurring Batch) The recurring batch definition that this batch is tied to
posting_workflow_execution_id	string (Posting Workflow Execution) The ID of the state machine execution that posted this batch
unposting_workflow_execution_id	string (Unposting Workflow Execution) The ID of the state machine execution that last unposted this batch
downloading_workflow_execution_id	string (Downloading Workflow Execution) The ID of the state machine execution that last downloaded this batch
dependents	Array of strings (Dependents) List of batches that depend on this one
total	number <double> (Total) The total amount of payments - refunds for the batch
count	number <float> (Count) The total # of payments + refunds
	object (Statistics)
sys_fiscal_period_id	string (Sys Fiscal Period) Concatenation of the fiscal year and fiscal period
sys_composite_fiscal_period_key	string (Sys Composite Fiscal Period Key) Internal use
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (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_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The batch was updated successfully.

400The batch supplied was not valid.

401Unauthorized.

403Forbidden.

404The batch could not be found.

409The batch could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve batch based on tenant limits.

500General server error.

put/batches/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a batch with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the batch to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value)

Responses

200The batch was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The batch could not be found.

409The batch could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve batch based on tenant limits.

500General server error.

patch/batches/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a batch from the system by its ID.

This method will delete a batch with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the batch to delete.

Responses

200The batch was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The batch could not be found.

409The batch could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete batch based on tenant limits.

500General server error.

delete/batches/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://collect.api.756794052567.rhythmsoftware.com/batches/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Recursively retrieve batches dependent on a set of batches

Returns a list of child batches dependent on the batches specified

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

query Parameters

ids

required

string

The batch IDs

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/batches/{tenantId}/dependents

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/batches/:tenantId/dependents?ids=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"children": ["string"
]
}

Returns a list of records with the specified fiscal_year_id and fiscal_period

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
fiscal_year_id required	string The fiscal_year_id to use to for record lookup
fiscal_period required	string The fiscal_period to use to for record lookup

query Parameters

fields

string

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

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/batches/{tenantId}/fiscal_period/{fiscal_year_id}/{fiscal_period}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/batches/:tenantId/fiscal_period/:fiscal_year_id/:fiscal_period?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified status

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
businessUnitId required	string The business unt
status required	string The status to use to for record lookup

query Parameters

fields

string

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

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/batches/{tenantId}/status/{status}/{businessUnitId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/batches/:tenantId/status/:status/:businessUnitId?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"name": "string",
"description": "string",
"errors": [{"transaction_type": "string",
"transaction_id": "string",
"error_message": "string"
}
],
"currency_code": "str",
"currency_symbol": "string",
"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"date": "2019-08-24",
"posted_at": "2019-08-24T14:15:22Z",
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"downloaded_at": "2019-08-24T14:15:22Z",
"type": "transaction",
"automatically_close_at": "2019-08-24T14:15:22Z",
"recurring_batch_id": "string",
"posting_workflow_execution_id": "string",
"unposting_workflow_execution_id": "string",
"downloading_workflow_execution_id": "string",
"dependents": ["string"
],
"total": 0,
"count": 0,
"statistics": {"number_of_payments": 0,
"payment_total": 0,
"number_of_refunds": 0,
"refund_total": 0,
"number_of_invoices": 0,
"invoice_total": 0,
"number_of_credit_memos": 0,
"credit_memo_total": 0,
"number_of_debit_memos": 0,
"debit_memo_total": 0,
"number_of_credits": 0,
"credit_total": 0,
"number_of_write_offs": 0,
"write_off_total": 0
},
"sys_fiscal_period_id": "string",
"sys_composite_fiscal_period_key": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Searches for batches using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The batch that you would like to be saved.

business_unit_id	string (Business Unit)
fiscal_year_id	string (Fiscal Year)
fiscal_period	number <float> (Fiscal Period) [ 1 .. 12 ]
type	Array of strings (Type) Items Enum: "transaction" "deferred revenue" "cost of goods sold"
recurring_batch_id	Array of strings (Recurring Batch)
status	Array of strings (Status) Items Enum: "open" "closed" "verified" "posting" "posted" "downloaded" "error"
date	Array of strings (Date) 2 items
count	Array of strings (Count) 2 items
total	Array of strings (Total) 2 items
name	string (Name)
id	Array of strings (ID)

Responses

200The batch search was saved successfully.

400The batch you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The batch could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add batch based on tenant limits.

500General server error.

post/batches/{tenantId}/search

Request samples

application/json

{"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"type": ["transaction"
],
"recurring_batch_id": ["string"
],
"status": ["open"
],
"date": ["string",
"string"
],
"count": ["string",
"string"
],
"total": ["string",
"string"
],
"name": "string",
"id": ["string"
]
}

Response samples

application/json

{"Items": [{"business_unit_id": "string",
"fiscal_year_id": "string",
"fiscal_period": 1,
"type": "transaction",
"recurring_batch_id": "string",
"status": "open",
"date": "2019-08-24T14:15:22Z",
"name": "string",
"id": "string"
}
],
"LastEvaluatedKey": "string"
}

Execute Batch Operations

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The batch could not be found.

429Limit exceeded... unable to retrieve batch based on tenant limits.

500General server error.

post/batches/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}