This method will look up a billing run action by the specified ID and return it back.
curl -i -X GET \ 'https://membership.api.756794052567.rhythmsoftware.com/billingRunActions/:tenantId/:id?fields=string&consistentRead=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "id": "string",
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "billing_run_id": "string",
- "membership_id": "string",
- "reminder_number": 0,
- "membership_expiration_date": "string",
- "success_notice_id": "string",
- "failure_notice_id": "string",
- "type": "renewal order",
- "last_refresh_date": "2019-08-24T14:15:22Z",
- "outcome_of_last_refresh": "no change",
- "status": "pending",
- "error_message": "string",
- "order_id": "string",
- "step_function_execution_arn": "string",
- "error_stack": "string",
- "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"
}
]
}
This method will update an existing billing run action with the specified ID.
The updated billing run action that will be saved.
{- "id": "string",
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "billing_run_id": "string",
- "membership_id": "string",
- "reminder_number": 0,
- "membership_expiration_date": "string",
- "success_notice_id": "string",
- "failure_notice_id": "string",
- "type": "renewal order",
- "last_refresh_date": "2019-08-24T14:15:22Z",
- "outcome_of_last_refresh": "no change",
- "status": "pending",
- "error_message": "string",
- "order_id": "string",
- "step_function_execution_arn": "string",
- "error_stack": "string",
- "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"
}
]
}
{- "id": "string",
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "billing_run_id": "string",
- "membership_id": "string",
- "reminder_number": 0,
- "membership_expiration_date": "string",
- "success_notice_id": "string",
- "failure_notice_id": "string",
- "type": "renewal order",
- "last_refresh_date": "2019-08-24T14:15:22Z",
- "outcome_of_last_refresh": "no change",
- "status": "pending",
- "error_message": "string",
- "order_id": "string",
- "step_function_execution_arn": "string",
- "error_stack": "string",
- "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"
}
]
}
This method will patch an existing billing run action with the specified ID, using the HTTP PATCH specification.
The patch directives conforming to RFC 6902.
[- {
- "op": "add",
- "path": "string",
- "value": "string"
}
]
{- "id": "string",
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "billing_run_id": "string",
- "membership_id": "string",
- "reminder_number": 0,
- "membership_expiration_date": "string",
- "success_notice_id": "string",
- "failure_notice_id": "string",
- "type": "renewal order",
- "last_refresh_date": "2019-08-24T14:15:22Z",
- "outcome_of_last_refresh": "no change",
- "status": "pending",
- "error_message": "string",
- "order_id": "string",
- "step_function_execution_arn": "string",
- "error_stack": "string",
- "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 list of records with the specified billing_run_id
curl -i -X GET \ 'https://membership.api.756794052567.rhythmsoftware.com/billingRunActions/:tenantId/billingRun/:billing_run_id?fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "Count": 0,
- "Items": [
- {
- "id": "string",
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "billing_run_id": "string",
- "membership_id": "string",
- "reminder_number": 0,
- "membership_expiration_date": "string",
- "success_notice_id": "string",
- "failure_notice_id": "string",
- "type": "renewal order",
- "last_refresh_date": "2019-08-24T14:15:22Z",
- "outcome_of_last_refresh": "no change",
- "status": "pending",
- "error_message": "string",
- "order_id": "string",
- "step_function_execution_arn": "string",
- "error_stack": "string",
- "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 membership_id
curl -i -X GET \ 'https://membership.api.756794052567.rhythmsoftware.com/billingRunActions/:tenantId/membership/:membership_id?fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "Count": 0,
- "Items": [
- {
- "id": "string",
- "date": "2019-08-24T14:15:22Z",
- "name": "string",
- "billing_run_id": "string",
- "membership_id": "string",
- "reminder_number": 0,
- "membership_expiration_date": "string",
- "success_notice_id": "string",
- "failure_notice_id": "string",
- "type": "renewal order",
- "last_refresh_date": "2019-08-24T14:15:22Z",
- "outcome_of_last_refresh": "no change",
- "status": "pending",
- "error_message": "string",
- "order_id": "string",
- "step_function_execution_arn": "string",
- "error_stack": "string",
- "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"
}
TAllows you to perform up to 100 parallel patch/delete operations
The batch request
Array of objects |
{- "operations": [
- {
- "operation": "create",
- "id": "string",
- "patch_directives": [
- {
- "op": "add",
- "path": "string",
- "value": "string"
}
], - "object": { }
}
]
}
{- "success_count": 0,
- "error_count": 0,
- "results": [
- {
- "operation": "create",
- "id": "string",
- "outcome": "success",
- "error_message": "string",
- "object": { }
}
]
}