Skip to content
Collect
/
/
Searches for refunds usin...

Collect (Finance & Billing) (v1-2025-04-18)

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.

Download OpenAPI description
collect-v1.json
collect-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1
https://collect.api.rhythmsoftware.com

Accounting Projects

Accounting Projects

Operations

Bank Accounts

Bank Accounts

Operations

Batch Assignment Settings

Batch Assignment Settings

Operations

Batch Downloading

Batch Downloading

Operations

Batch Posting

Batch Posting

Operations

Batch Templates

Batch Templates

Operations

Batches

Batches

Operations

Billing Notices

Billing Notices

Operations

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

Billing Templates

Billing Templates

Operations

Business Units

Business Units

Operations

Check Request Processes

Check Request Processes

Operations

Check Request Templates

Check Request Templates

Operations

Check Requests

Check Requests

Operations

Cogs Entries

Cogs Entries

Operations

Credit Memos

Credit Memos

Operations

Credits

Credits

Operations

Currency Mapping Policies

Currency Mapping Policies

Operations

Debit Memos

Debit Memos

Operations

Departments

Departments

Operations

Donation Products

Donation Products

Operations

Exchange Rates

Exchange Rates

Operations

External Payments

External Payments

Operations

Fiscal Years

Fiscal Years

Operations

Gateway Entities

Gateway Entities

Operations

Gateway Entries

Gateway Entries

Operations

Gateway Fees

Gateway Fees

Operations

Gl Accounts

Gl Accounts

Operations

Installment Plans

Installment Plans

Operations

Installment Schedules

Installment Schedules

Operations

Invoice Payment Terms

Invoice Payment Terms

Operations

Invoice Templates

Invoice Templates

Operations

Invoice Types

Invoice Types

Operations

Invoices

Invoices

Operations

Late Fee Rules

Late Fee Rules

Operations

Late Fees

Late Fees

Operations

Legacy Import Products

Legacy Import Products

Operations

Merchant Accounts

Merchant Accounts

Operations

Miscellaneous Products

Miscellaneous Products

Operations

Payment Receipt Templates

Payment Receipt Templates

Operations

Payments

Payments

Operations

Product Financial Configs

Product Financial Configs

Operations

Query Definitions

Query Definitions

Operations

Recurring Batches

Recurring Batches

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Refund Receipt Templates

Refund Receipt Templates

Operations

Refunds

Refunds

Operations

Returns the default refund template

Request

Returns the default refund template

Security
knox-authorizer
curl -i -X GET \
  https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/defaultTemplate/refund \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The refund template

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodytext/html
string

Initiates workflow to warm up inventory transactions

Request

Security
knox-authorizer
curl -i -X POST \
  https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/warmUpStepFunctions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Gets all of the refunds in the system.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

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

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The refundswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

]
Response
application/json
[
  {
    "bank_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "cash_account_type": "bank",
    "confirmation_email_recipients": [ … ],
    "credit_id": "string",
    "currency_code": "AED",
    "currency_symbol": "string",
    "custom_field_values": [ … ],
    "date": "2019-08-24",
    "do_not_perform_electronic_refund": true,
    "exchange_rate": 0.1,
    "id": "string",
    "ignore_payment_gateway_errors": true,
    "line_items": [ … ],
    "memo": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "payment_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,
    "transaction_id": "string",
    "type": "credit",
    "workflow_execution_id": "string"
  }
]

Creates a new refund that doesn't already exist

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The refund that you would like to be saved.

bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "cash_account_type": "bank",
    "confirmation_email_recipients": [
      "string"
    ],
    "credit_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",
    "do_not_perform_electronic_refund": true,
    "exchange_rate": 0.1,
    "id": "string",
    "ignore_payment_gateway_errors": true,
    "line_items": [
      {
        "payment_line_item_id": null,
        "refund_line_item_id": null,
        "total": 0.1,
        "total_in_base_currency": null
      }
    ],
    "memo": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "payment_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,
    "transaction_id": "string",
    "type": "credit",
    "workflow_execution_id": "string"
  }'

Responses

The refund was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring(date-time)(Start Date)

The start date of the execution

Response
application/json
{
  "executionArn": "string",
  "notification_channel": "string",
  "notification_publishKey": "string",
  "notification_subscribeKey": "string",
  "start_date": "2019-08-24T14:15:22Z"
}

Execute Batch Operations

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a list of records with the specified batch_id

Request

Returns a list of records with the specified batch_id

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

batch_idstringrequired

The batch_id to use to for record lookup

Query
fieldsstring

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

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/batch/{batch_id}?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Refund)
LastEvaluatedKeystring
Response
application/json
{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Sends out a preview of the notification template

Request

Sends out a preview of the notification template

Security
knox-authorizer
Path
tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

contact_idstring(Contact)required
customer_typestring(Customer Type)required
Enum"contact""organization"
idstring(ID)

The refund id

invoice_idstring(Invoice)
organization_idstring(Organization)required
templatestring(Template)required
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/previewTemplate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contact_id": "string",
    "customer_type": "contact",
    "id": "string",
    "invoice_id": "string",
    "organization_id": "string",
    "template": "string"
  }'

Responses

The record was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Generates a PDF and returns the public link for download

Request

Generates a PDF and returns the public link for download

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed

idstringrequired

The ID of the refund to return

Query
downloadAsHtmlboolean

If true, return the receipt as HTML

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/print/{id}?downloadAsHtml=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The refund was downloaded successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Searches for refunds using predefined parameters

Request

Searches for refunds using predefined parameters

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The refund that you would like to be saved.

bank_account_idArray of strings(Bank Account)= 2 items
batch_idArray of strings(Batch)
business_unit_idstring(Business Unit)required

The business unit

dateArray of strings(Date)= 2 items
idArray of strings(ID)
merchant_account_idArray of strings(Merchant Account)= 2 items
numberArray of numbers(float)(Number)= 2 items
totalArray of numbers(float)(Total)= 2 items
total_in_base_currencyArray of numbers(float)(Total In Base Currency)= 2 items
transaction_idstring(Transaction)
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account_id": [
      "string",
      "string"
    ],
    "batch_id": [
      "string"
    ],
    "business_unit_id": "string",
    "date": [
      "string",
      "string"
    ],
    "id": [
      "string"
    ],
    "merchant_account_id": [
      "string",
      "string"
    ],
    "number": [
      0.1,
      0.1
    ],
    "total": [
      0.1,
      0.1
    ],
    "total_in_base_currency": [
      0.1,
      0.1
    ],
    "transaction_id": "string"
  }'

Responses

The refund search was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
ItemsArray of objects(RefundSearchResults)
LastEvaluatedKeystring
Response
application/json
{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Creates a new refund that doesn't already exist

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The refund that you would like to be saved.

bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "cash_account_type": "bank",
    "confirmation_email_recipients": [
      "string"
    ],
    "credit_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",
    "do_not_perform_electronic_refund": true,
    "exchange_rate": 0.1,
    "id": "string",
    "ignore_payment_gateway_errors": true,
    "line_items": [
      {
        "payment_line_item_id": null,
        "refund_line_item_id": null,
        "total": 0.1,
        "total_in_base_currency": null
      }
    ],
    "memo": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "payment_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,
    "transaction_id": "string",
    "type": "credit",
    "workflow_execution_id": "string"
  }'

Responses

The refund was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response
application/json
{
  "bank_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "cash_account_type": "bank",
  "confirmation_email_recipients": [
    "string"
  ],
  "credit_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "do_not_perform_electronic_refund": true,
  "exchange_rate": 0.1,
  "id": "string",
  "ignore_payment_gateway_errors": true,
  "line_items": [
    { … }
  ],
  "memo": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "payment_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,
  "transaction_id": "string",
  "type": "credit",
  "workflow_execution_id": "string"
}

Returns a refund from the system by its ID.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the refund to return.

Query
fieldsstring

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

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/{id}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The refund was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response
application/json
{
  "bank_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "cash_account_type": "bank",
  "confirmation_email_recipients": [
    "string"
  ],
  "credit_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "do_not_perform_electronic_refund": true,
  "exchange_rate": 0.1,
  "id": "string",
  "ignore_payment_gateway_errors": true,
  "line_items": [
    { … }
  ],
  "memo": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "payment_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,
  "transaction_id": "string",
  "type": "credit",
  "workflow_execution_id": "string"
}

Partially updates a refund with the specified ID.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the refund to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"
pathstring(Path)required

The JSON path

valuestring(Value)
]
curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The refund was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response
application/json
{
  "bank_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "cash_account_type": "bank",
  "confirmation_email_recipients": [
    "string"
  ],
  "credit_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "do_not_perform_electronic_refund": true,
  "exchange_rate": 0.1,
  "id": "string",
  "ignore_payment_gateway_errors": true,
  "line_items": [
    { … }
  ],
  "memo": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "payment_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,
  "transaction_id": "string",
  "type": "credit",
  "workflow_execution_id": "string"
}

Updates a refund with the specified ID.

Request

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

Security
knox-authorizer
Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the refund to update.

Bodyapplication/jsonrequired

The updated refund that will be saved.

bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/refunds/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bank_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "cash_account_type": "bank",
    "confirmation_email_recipients": [
      "string"
    ],
    "credit_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",
    "do_not_perform_electronic_refund": true,
    "exchange_rate": 0.1,
    "id": "string",
    "ignore_payment_gateway_errors": true,
    "line_items": [
      {
        "payment_line_item_id": null,
        "refund_line_item_id": null,
        "total": 0.1,
        "total_in_base_currency": null
      }
    ],
    "memo": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "payment_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,
    "transaction_id": "string",
    "type": "credit",
    "workflow_execution_id": "string"
  }'

Responses

The refund was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
bank_account_idstring(Bank Account)required

The bank account to use for this payment

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

cash_account_typestring(Cash Account Type)required

Type of cash account to use

Enum"bank""merchant""none"
confirmation_email_recipientsArray of strings(Confirmation Email Recipients)

Send a confirmation email to these recipients

credit_idstring(Credit)required

The credit being refunded

currency_codestring(Currency Code)= 3 characters

The currency code in use

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"
currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)
datestring(date)(Date)

The date of the transaction

do_not_perform_electronic_refundboolean(Do Not Perform Electronic Refund)

If set, the refund process will NOT perform an electronic refund

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this refund

ignore_payment_gateway_errorsboolean(Ignore Payment Gateway Errors)

If true, payment gateway errors are ignored

line_itemsArray of objects
memostring(Memo)

Memo/description of the transaction

merchant_account_idstring(Merchant Account)required

The merchant account to use for this payment

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

payment_idstring(Payment)required

The payment being refunded

return_idstring(Return)

The return tied to this transaction

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_search_composite_keystring(Sys Search Composite Key)

Internal use

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

transaction_idstring(Transaction)

For electronic refunds, the transaction id

typestring(Type)required

The type of object being refunded

Enum"credit""payment"
workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response
application/json
{
  "bank_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "cash_account_type": "bank",
  "confirmation_email_recipients": [
    "string"
  ],
  "credit_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "do_not_perform_electronic_refund": true,
  "exchange_rate": 0.1,
  "id": "string",
  "ignore_payment_gateway_errors": true,
  "line_items": [
    { … }
  ],
  "memo": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "payment_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,
  "transaction_id": "string",
  "type": "credit",
  "workflow_execution_id": "string"
}

Revenue Recognition Schedules

Revenue Recognition Schedules

Operations

Settings

Settings

Operations

Statement Templates

Statement Templates

Operations

Statements

Statements

Operations

Statistics

Statistics

Operations

Stored Payment Methods

Stored Payment Methods

Operations

Subledger Entries

Subledger Entries

Operations

Write Offs

Write Offs

Operations