This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown.
The credit that you would like to be saved.
{- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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"
}
]
}
{- "notification_publishKey": "string",
- "notification_subscribeKey": "string",
- "notification_channel": "string",
- "executionArn": "string",
- "start_date": "2019-08-24T14:15:22Z"
}
This method will scan all credits and and return them to the caller.
curl -i -X GET \ 'https://collect.api.756794052567.rhythmsoftware.com/credits/:tenantId?fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
[- {
- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown.
The credit that you would like to be saved.
{- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 look up a credit by the specified ID and return it back.
curl -i -X GET \ 'https://collect.api.756794052567.rhythmsoftware.com/credits/:tenantId/:id?fields=string&consistentRead=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 credit with the specified ID.
The updated credit that will be saved.
{- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 credit with the specified ID, using the HTTP PATCH specification.
The patch directives conforming to RFC 6902.
[- {
- "op": "add",
- "path": "string",
- "value": "string"
}
]
{- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 delete a credit with the specified ID.
curl -i -X DELETE \ https://collect.api.756794052567.rhythmsoftware.com/credits/:tenantId/:id \ -H 'Authorization: YOUR_API_KEY_HERE'
"string"
Searches for credits using predefined parameters
The credit that you would like to be saved.
{- "business_unit_id": "string",
- "batch_id": [
- "string"
], - "date": [
- "string",
- "string"
], - "number": [
- 0,
- 0
], - "total": [
- 0,
- 0
], - "id": [
- "string"
], - "total_in_base_currency": [
- 0,
- 0
]
}
{- "Items": [
- {
- "id": "string",
- "business_unit_id": "string",
- "batch_id": "string",
- "date": "string",
- "number": 0,
- "total": 0,
- "currency_symbol": "string",
- "total_in_base_currency": 0,
- "base_currency_symbol": "string"
}
], - "LastEvaluatedKey": "string"
}
Returns a list of records with the specified batch_id
curl -i -X GET \ 'https://collect.api.756794052567.rhythmsoftware.com/credits/:tenantId/batch/:batch_id?fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "Count": 0,
- "Items": [
- {
- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 contact_id
curl -i -X GET \ 'https://collect.api.756794052567.rhythmsoftware.com/credits/:tenantId/contact/:contact_id?onlyIncludeOpenCredits=true&fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "Count": 0,
- "Items": [
- {
- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 organization_id
curl -i -X GET \ 'https://collect.api.756794052567.rhythmsoftware.com/credits/:tenantId/organization/:organization_id?onlyIncludeOpenCredits=true&fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "Count": 0,
- "Items": [
- {
- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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 owner_id
curl -i -X GET \ 'https://collect.api.756794052567.rhythmsoftware.com/credits/:tenantId/owner/:owner_type/:owner_id?onlyIncludeOpenCredits=true&fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "Count": 0,
- "Items": [
- {
- "id": "string",
- "type": "payment",
- "payment_id": "string",
- "confirmation_email_recipients": [
- "string"
], - "payment_line_item_id": "string",
- "owner_type": "contact",
- "contact_id": "string",
- "organization_id": "string",
- "amount_used": 0,
- "amount_available": 0,
- "liability_gl_account_id": "string",
- "expense_gl_account_id": "string",
- "related_transactions": [
- {
- "type": "payment",
- "transaction_id": "string",
- "transaction_number": 0,
- "transaction_line_item_id": "string",
- "amount": 0,
- "date": "2019-08-24T14:15:22Z"
}
], - "line_items": [
- {
- "credit_line_item_id": "string",
- "payment_line_item_id": "string",
- "total_in_base_currency": 0,
- "total": 0
}
], - "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_owner_id": "string",
- "number": 0,
- "workflow_execution_id": "string",
- "total": 0,
- "business_unit_id": "string",
- "batch_id": "string",
- "cancellation_id": "string",
- "order_id": "string",
- "return_id": "string",
- "memo": "string",
- "notes": "string",
- "date": "2019-08-24",
- "currency_code": "AED",
- "currency_symbol": "string",
- "exchange_rate": 0,
- "total_in_base_currency": 0,
- "base_currency_code": "str",
- "base_currency_symbol": "string",
- "sys_search_composite_key": "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"
}
curl -i -X POST \ https://collect.api.756794052567.rhythmsoftware.com/credits/warmUpStepFunctions \ -H 'Authorization: YOUR_API_KEY_HERE'
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": { }
}
]
}