The Finance, or Collect, API provides all the accounts receivable capabilities in Rhythm. This includes all aspects of Invoices, Credits, Payments, Credit Memos, and Debit Memos. Additionally, this API manages Batches and Fiscal Periods and can be used to download batches for import into your accounting package.
Like most of the other Rhythm apps, the Collect API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/
https://collect.api.rhythmsoftware.com/
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/warmUpStepFunctions
https://collect.api.rhythmsoftware.com/writeOffs/warmUpStepFunctions
curl -i -X POST \
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/warmUpStepFunctions \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The write offswere retrieved successfully.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
The ID of the state machine execution used to create this transaction
[ { "bad_debts_expense_gl_account_id": "string", "base_currency_code": "str", "base_currency_symbol": "string", "batch_id": "string", "business_unit_id": "string", "cancellation_id": "string", "currency_code": "AED", "currency_symbol": "string", "custom_field_values": [ … ], "date": "2019-08-24", "exchange_rate": 0.1, "id": "string", "invoice_id": "string", "line_items": [ … ], "memo": "string", "method": "allowance", "notes": "string", "number": 0, "order_id": "string", "return_id": "string", "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_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_search_composite_key": "string", "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "total": 0.1, "total_in_base_currency": 0.1, "workflow_execution_id": "string" } ]
The write off that you would like to be saved.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"bad_debts_expense_gl_account_id": "string",
"base_currency_code": "str",
"base_currency_symbol": "string",
"batch_id": "string",
"business_unit_id": "string",
"cancellation_id": "string",
"currency_code": "AED",
"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",
"exchange_rate": 0.1,
"id": "string",
"invoice_id": "string",
"line_items": [
{
"description": "string",
"invoice_line_item_id": "string",
"product_id": "string",
"product_type": "string",
"total": 0.1,
"total_in_base_currency": null
}
],
"memo": "string",
"method": "allowance",
"notes": "string",
"number": 0,
"order_id": "string",
"return_id": "string",
"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_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_search_composite_key": "string",
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"total": 0.1,
"total_in_base_currency": 0.1,
"workflow_execution_id": "string"
}'{ "executionArn": "string", "notification_channel": "string", "notification_publishKey": "string", "notification_subscribeKey": "string", "start_date": "2019-08-24T14:15:22Z" }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/batch
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{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"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/batch/{batch_id}
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}/batch/{batch_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/batch/{batch_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/search
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}/search
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"batch_id": [
"string"
],
"business_unit_id": "string",
"date": [
"string",
"string"
],
"id": [
"string"
],
"number": [
0.1,
0.1
],
"total": [
0.1,
0.1
],
"total_in_base_currency": [
0.1,
0.1
]
}'{ "Items": [ { … } ], "LastEvaluatedKey": "string" }
The write off that you would like to be saved.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/sync
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}/sync
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/sync' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"bad_debts_expense_gl_account_id": "string",
"base_currency_code": "str",
"base_currency_symbol": "string",
"batch_id": "string",
"business_unit_id": "string",
"cancellation_id": "string",
"currency_code": "AED",
"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",
"exchange_rate": 0.1,
"id": "string",
"invoice_id": "string",
"line_items": [
{
"description": "string",
"invoice_line_item_id": "string",
"product_id": "string",
"product_type": "string",
"total": 0.1,
"total_in_base_currency": null
}
],
"memo": "string",
"method": "allowance",
"notes": "string",
"number": 0,
"order_id": "string",
"return_id": "string",
"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_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_search_composite_key": "string",
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"total": 0.1,
"total_in_base_currency": 0.1,
"workflow_execution_id": "string"
}'The write off was saved successfully.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
{ "bad_debts_expense_gl_account_id": "string", "base_currency_code": "str", "base_currency_symbol": "string", "batch_id": "string", "business_unit_id": "string", "cancellation_id": "string", "currency_code": "AED", "currency_symbol": "string", "custom_field_values": [ { … } ], "date": "2019-08-24", "exchange_rate": 0.1, "id": "string", "invoice_id": "string", "line_items": [ { … } ], "memo": "string", "method": "allowance", "notes": "string", "number": 0, "order_id": "string", "return_id": "string", "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_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_search_composite_key": "string", "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "total": 0.1, "total_in_base_currency": 0.1, "workflow_execution_id": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/{id}
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The write off was retrieved successfully.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
{ "bad_debts_expense_gl_account_id": "string", "base_currency_code": "str", "base_currency_symbol": "string", "batch_id": "string", "business_unit_id": "string", "cancellation_id": "string", "currency_code": "AED", "currency_symbol": "string", "custom_field_values": [ { … } ], "date": "2019-08-24", "exchange_rate": 0.1, "id": "string", "invoice_id": "string", "line_items": [ { … } ], "memo": "string", "method": "allowance", "notes": "string", "number": 0, "order_id": "string", "return_id": "string", "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_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_search_composite_key": "string", "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "total": 0.1, "total_in_base_currency": 0.1, "workflow_execution_id": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/{id}
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The write off was patched successfully.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
{ "bad_debts_expense_gl_account_id": "string", "base_currency_code": "str", "base_currency_symbol": "string", "batch_id": "string", "business_unit_id": "string", "cancellation_id": "string", "currency_code": "AED", "currency_symbol": "string", "custom_field_values": [ { … } ], "date": "2019-08-24", "exchange_rate": 0.1, "id": "string", "invoice_id": "string", "line_items": [ { … } ], "memo": "string", "method": "allowance", "notes": "string", "number": 0, "order_id": "string", "return_id": "string", "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_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_search_composite_key": "string", "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "total": 0.1, "total_in_base_currency": 0.1, "workflow_execution_id": "string" }
The updated write off that will be saved.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/{id}
https://collect.api.rhythmsoftware.com/writeOffs/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"bad_debts_expense_gl_account_id": "string",
"base_currency_code": "str",
"base_currency_symbol": "string",
"batch_id": "string",
"business_unit_id": "string",
"cancellation_id": "string",
"currency_code": "AED",
"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",
"exchange_rate": 0.1,
"id": "string",
"invoice_id": "string",
"line_items": [
{
"description": "string",
"invoice_line_item_id": "string",
"product_id": "string",
"product_type": "string",
"total": 0.1,
"total_in_base_currency": null
}
],
"memo": "string",
"method": "allowance",
"notes": "string",
"number": 0,
"order_id": "string",
"return_id": "string",
"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_configuration_snapshot_id": "string",
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_deleted_by_id": "string",
"sys_directive": "string",
"sys_external_id": "string",
"sys_has_files_in_s3": true,
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_last_modified_by_id": "string",
"sys_last_security_context": {},
"sys_locked": true,
"sys_search_composite_key": "string",
"sys_snapshot_base_version": 0.1,
"sys_version": 0.1,
"total": 0.1,
"total_in_base_currency": 0.1,
"workflow_execution_id": "string"
}'The write off was updated successfully.
Bad debts expense GL account, required for allowance method
The base currency for transactions business unit
The currency code in use
The total of the transaction, in the base currency of the business unit.
The invoice line item being modified
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
The total of the transaction, in the base currency of the business unit.
{ "bad_debts_expense_gl_account_id": "string", "base_currency_code": "str", "base_currency_symbol": "string", "batch_id": "string", "business_unit_id": "string", "cancellation_id": "string", "currency_code": "AED", "currency_symbol": "string", "custom_field_values": [ { … } ], "date": "2019-08-24", "exchange_rate": 0.1, "id": "string", "invoice_id": "string", "line_items": [ { … } ], "memo": "string", "method": "allowance", "notes": "string", "number": 0, "order_id": "string", "return_id": "string", "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_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_search_composite_key": "string", "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "total": 0.1, "total_in_base_currency": 0.1, "workflow_execution_id": "string" }