Billing Run Actions

Accounting Projects

Operations

Bank Accounts

Operations

Batch Assignment Settings

Operations

Batch Downloading

Operations

Batch Posting

Operations

Batch Templates

Operations

Batches

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Creates a new billing run action record that does not already exist.

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The billing run action that you would like to be saved.

billing_notice_idstring(Billing Notice)required

The billing notice

billing_run_idstring(Billing Run)required

The billing run ID

candidate_idstring(Candidate)required

The candidate to which this action is linked

candidate_servicestring(Candidate Service)required

The service of the candidate

citystring(City)

The member city

contact_idstring(Contact)required

contact_namestring(Contact Name)

The name of the contact

countrystring(Country)

The member country

customer_idstring(Customer)required

The contact or organization ID

customer_typestring(Customer Type)required

Enum"contact""organization"

datestring(Date)required

The applicable date

email_addressstring(Email Address)

The member's email address

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

execution_arnstring(Execution Arn)

If tied to a step function, the execution ARN

failed_billing_notice_idstring(Failed Billing Notice)

The notice to send when processing fails

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this billing run action

installment_schedule_idstring(Installment Schedule)required

The installment schedule ID

invoice_idstring(Invoice)required

The invoice ID affected by this action

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

namestring(Name)required

Name of the membership

order_idstring(Order)required

The order ID affected by this action

organization_idstring(Organization)required

organization_namestring(Organization Name)

The name of the organization

outcome_of_last_refreshstring(Outcome Of Last Refresh)

Describes what happened to this action the last time this billing run was refreshed

Enum"added""no change""removed"

statestring(State)

The state

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

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_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

typestring(Type)required

Enum"cancel installment schedule""installment schedule reminder""process installment schedule""remind expiring credit card""send statement"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRunActions/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_notice_id": "string",
    "billing_run_id": "string",
    "candidate_id": "string",
    "candidate_service": "string",
    "city": "string",
    "contact_id": "string",
    "contact_name": "string",
    "country": "string",
    "customer_id": "string",
    "customer_type": "contact",
    "date": "string",
    "email_address": "string",
    "error_message": "string",
    "error_stack": "string",
    "execution_arn": "string",
    "failed_billing_notice_id": "string",
    "first_name": "string",
    "id": "string",
    "installment_schedule_id": "string",
    "invoice_id": "string",
    "job_title": "string",
    "last_name": "string",
    "last_refresh_date": "2019-08-24T14:15:22Z",
    "name": "string",
    "order_id": "string",
    "organization_id": "string",
    "organization_name": "string",
    "outcome_of_last_refresh": "added",
    "state": "string",
    "status": "completed",
    "step_function_execution_arn": "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_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "cancel installment schedule"
  }'

Responses

The billing run action was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_notice_idstring(Billing Notice)required

The billing notice

billing_run_idstring(Billing Run)required

The billing run ID

candidate_idstring(Candidate)required

The candidate to which this action is linked

candidate_servicestring(Candidate Service)required

The service of the candidate

citystring(City)

The member city

contact_idstring(Contact)required

contact_namestring(Contact Name)

The name of the contact

countrystring(Country)

The member country

customer_idstring(Customer)required

The contact or organization ID

customer_typestring(Customer Type)required

Enum"contact""organization"

datestring(Date)required

The applicable date

email_addressstring(Email Address)

The member's email address

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

execution_arnstring(Execution Arn)

If tied to a step function, the execution ARN

failed_billing_notice_idstring(Failed Billing Notice)

The notice to send when processing fails

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this billing run action

installment_schedule_idstring(Installment Schedule)required

The installment schedule ID

invoice_idstring(Invoice)required

The invoice ID affected by this action

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

namestring(Name)required

Name of the membership

order_idstring(Order)required

The order ID affected by this action

organization_idstring(Organization)required

organization_namestring(Organization Name)

The name of the organization

outcome_of_last_refreshstring(Outcome Of Last Refresh)

Describes what happened to this action the last time this billing run was refreshed

Enum"added""no change""removed"

statestring(State)

The state

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

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_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

typestring(Type)required

Enum"cancel installment schedule""installment schedule reminder""process installment schedule""remind expiring credit card""send statement"

Response

application/json

{
  "billing_notice_id": "string",
  "billing_run_id": "string",
  "candidate_id": "string",
  "candidate_service": "string",
  "city": "string",
  "contact_id": "string",
  "contact_name": "string",
  "country": "string",
  "customer_id": "string",
  "customer_type": "contact",
  "date": "string",
  "email_address": "string",
  "error_message": "string",
  "error_stack": "string",
  "execution_arn": "string",
  "failed_billing_notice_id": "string",
  "first_name": "string",
  "id": "string",
  "installment_schedule_id": "string",
  "invoice_id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_refresh_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "order_id": "string",
  "organization_id": "string",
  "organization_name": "string",
  "outcome_of_last_refresh": "added",
  "state": "string",
  "status": "completed",
  "step_function_execution_arn": "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_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "cancel installment schedule"
}

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/billingRunActions/{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 billing_run_id

Request

Returns a list of records with the specified billing_run_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

billing_run_idstringrequired

The billing_run_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/billingRunActions/{tenantId}/billingRun/{billing_run_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(BillingRunAction)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a billing run action from the system by its ID.

Request

This method will delete a billing run action with the specified ID.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run action to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRunActions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing run action was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a billing run action from the system by its ID.

Request

This method will look up a billing run action 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 billing run action 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/billingRunActions/{tenantId}/{id}?fields=string&consistentRead=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The billing run action was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_notice_idstring(Billing Notice)required

The billing notice

billing_run_idstring(Billing Run)required

The billing run ID

candidate_idstring(Candidate)required

The candidate to which this action is linked

candidate_servicestring(Candidate Service)required

The service of the candidate

citystring(City)

The member city

contact_idstring(Contact)required

contact_namestring(Contact Name)

The name of the contact

countrystring(Country)

The member country

customer_idstring(Customer)required

The contact or organization ID

customer_typestring(Customer Type)required

Enum"contact""organization"

datestring(Date)required

The applicable date

email_addressstring(Email Address)

The member's email address

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

execution_arnstring(Execution Arn)

If tied to a step function, the execution ARN

failed_billing_notice_idstring(Failed Billing Notice)

The notice to send when processing fails

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this billing run action

installment_schedule_idstring(Installment Schedule)required

The installment schedule ID

invoice_idstring(Invoice)required

The invoice ID affected by this action

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

namestring(Name)required

Name of the membership

order_idstring(Order)required

The order ID affected by this action

organization_idstring(Organization)required

organization_namestring(Organization Name)

The name of the organization

outcome_of_last_refreshstring(Outcome Of Last Refresh)

Describes what happened to this action the last time this billing run was refreshed

Enum"added""no change""removed"

statestring(State)

The state

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

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_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

typestring(Type)required

Enum"cancel installment schedule""installment schedule reminder""process installment schedule""remind expiring credit card""send statement"

Response

application/json

{
  "billing_notice_id": "string",
  "billing_run_id": "string",
  "candidate_id": "string",
  "candidate_service": "string",
  "city": "string",
  "contact_id": "string",
  "contact_name": "string",
  "country": "string",
  "customer_id": "string",
  "customer_type": "contact",
  "date": "string",
  "email_address": "string",
  "error_message": "string",
  "error_stack": "string",
  "execution_arn": "string",
  "failed_billing_notice_id": "string",
  "first_name": "string",
  "id": "string",
  "installment_schedule_id": "string",
  "invoice_id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_refresh_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "order_id": "string",
  "organization_id": "string",
  "organization_name": "string",
  "outcome_of_last_refresh": "added",
  "state": "string",
  "status": "completed",
  "step_function_execution_arn": "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_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "cancel installment schedule"
}

Partially updates a billing run action with the specified ID.

Request

This method will patch an existing billing run action 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 billing run action 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/billingRunActions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The billing run action was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_notice_idstring(Billing Notice)required

The billing notice

billing_run_idstring(Billing Run)required

The billing run ID

candidate_idstring(Candidate)required

The candidate to which this action is linked

candidate_servicestring(Candidate Service)required

The service of the candidate

citystring(City)

The member city

contact_idstring(Contact)required

contact_namestring(Contact Name)

The name of the contact

countrystring(Country)

The member country

customer_idstring(Customer)required

The contact or organization ID

customer_typestring(Customer Type)required

Enum"contact""organization"

datestring(Date)required

The applicable date

email_addressstring(Email Address)

The member's email address

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

execution_arnstring(Execution Arn)

If tied to a step function, the execution ARN

failed_billing_notice_idstring(Failed Billing Notice)

The notice to send when processing fails

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this billing run action

installment_schedule_idstring(Installment Schedule)required

The installment schedule ID

invoice_idstring(Invoice)required

The invoice ID affected by this action

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

namestring(Name)required

Name of the membership

order_idstring(Order)required

The order ID affected by this action

organization_idstring(Organization)required

organization_namestring(Organization Name)

The name of the organization

outcome_of_last_refreshstring(Outcome Of Last Refresh)

Describes what happened to this action the last time this billing run was refreshed

Enum"added""no change""removed"

statestring(State)

The state

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

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_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

typestring(Type)required

Enum"cancel installment schedule""installment schedule reminder""process installment schedule""remind expiring credit card""send statement"

Response

application/json

{
  "billing_notice_id": "string",
  "billing_run_id": "string",
  "candidate_id": "string",
  "candidate_service": "string",
  "city": "string",
  "contact_id": "string",
  "contact_name": "string",
  "country": "string",
  "customer_id": "string",
  "customer_type": "contact",
  "date": "string",
  "email_address": "string",
  "error_message": "string",
  "error_stack": "string",
  "execution_arn": "string",
  "failed_billing_notice_id": "string",
  "first_name": "string",
  "id": "string",
  "installment_schedule_id": "string",
  "invoice_id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_refresh_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "order_id": "string",
  "organization_id": "string",
  "organization_name": "string",
  "outcome_of_last_refresh": "added",
  "state": "string",
  "status": "completed",
  "step_function_execution_arn": "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_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "cancel installment schedule"
}

Updates a billing run action with the specified ID.

Request

This method will update an existing billing run action with the specified ID.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the billing run action to update.

Bodyapplication/jsonrequired

The updated billing run action that will be saved.

billing_notice_idstring(Billing Notice)required

The billing notice

billing_run_idstring(Billing Run)required

The billing run ID

candidate_idstring(Candidate)required

The candidate to which this action is linked

candidate_servicestring(Candidate Service)required

The service of the candidate

citystring(City)

The member city

contact_idstring(Contact)required

contact_namestring(Contact Name)

The name of the contact

countrystring(Country)

The member country

customer_idstring(Customer)required

The contact or organization ID

customer_typestring(Customer Type)required

Enum"contact""organization"

datestring(Date)required

The applicable date

email_addressstring(Email Address)

The member's email address

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

execution_arnstring(Execution Arn)

If tied to a step function, the execution ARN

failed_billing_notice_idstring(Failed Billing Notice)

The notice to send when processing fails

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this billing run action

installment_schedule_idstring(Installment Schedule)required

The installment schedule ID

invoice_idstring(Invoice)required

The invoice ID affected by this action

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

namestring(Name)required

Name of the membership

order_idstring(Order)required

The order ID affected by this action

organization_idstring(Organization)required

organization_namestring(Organization Name)

The name of the organization

outcome_of_last_refreshstring(Outcome Of Last Refresh)

Describes what happened to this action the last time this billing run was refreshed

Enum"added""no change""removed"

statestring(State)

The state

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

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_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

typestring(Type)required

Enum"cancel installment schedule""installment schedule reminder""process installment schedule""remind expiring credit card""send statement"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/billingRunActions/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_notice_id": "string",
    "billing_run_id": "string",
    "candidate_id": "string",
    "candidate_service": "string",
    "city": "string",
    "contact_id": "string",
    "contact_name": "string",
    "country": "string",
    "customer_id": "string",
    "customer_type": "contact",
    "date": "string",
    "email_address": "string",
    "error_message": "string",
    "error_stack": "string",
    "execution_arn": "string",
    "failed_billing_notice_id": "string",
    "first_name": "string",
    "id": "string",
    "installment_schedule_id": "string",
    "invoice_id": "string",
    "job_title": "string",
    "last_name": "string",
    "last_refresh_date": "2019-08-24T14:15:22Z",
    "name": "string",
    "order_id": "string",
    "organization_id": "string",
    "organization_name": "string",
    "outcome_of_last_refresh": "added",
    "state": "string",
    "status": "completed",
    "step_function_execution_arn": "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_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "cancel installment schedule"
  }'

Responses

The billing run action was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

billing_notice_idstring(Billing Notice)required

The billing notice

billing_run_idstring(Billing Run)required

The billing run ID

candidate_idstring(Candidate)required

The candidate to which this action is linked

candidate_servicestring(Candidate Service)required

The service of the candidate

citystring(City)

The member city

contact_idstring(Contact)required

contact_namestring(Contact Name)

The name of the contact

countrystring(Country)

The member country

customer_idstring(Customer)required

The contact or organization ID

customer_typestring(Customer Type)required

Enum"contact""organization"

datestring(Date)required

The applicable date

email_addressstring(Email Address)

The member's email address

error_messagestring(Error Message)

The error message

error_stackstring(Error Stack)

A detailed error message with stack trace

execution_arnstring(Execution Arn)

If tied to a step function, the execution ARN

failed_billing_notice_idstring(Failed Billing Notice)

The notice to send when processing fails

first_namestring(First Name)

The member's first name

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

The unique, string identifier of this billing run action

installment_schedule_idstring(Installment Schedule)required

The installment schedule ID

invoice_idstring(Invoice)required

The invoice ID affected by this action

job_titlestring(Job Title)

The member job title

last_namestring(Last Name)

The member's last name

last_refresh_datestring(date-time)(Last Refresh Date)

The date this action was last refreshed

namestring(Name)required

Name of the membership

order_idstring(Order)required

The order ID affected by this action

organization_idstring(Organization)required

organization_namestring(Organization Name)

The name of the organization

outcome_of_last_refreshstring(Outcome Of Last Refresh)

Describes what happened to this action the last time this billing run was refreshed

Enum"added""no change""removed"

statestring(State)

The state

statusstring(Status)required

The status of this action

Enum"completed""error""excluded""expiration date changed""no longer eligible""payment failure""pending""processing""processing order"

step_function_execution_arnstring(Step Function Execution Arn)

The step function arn

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_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

typestring(Type)required

Enum"cancel installment schedule""installment schedule reminder""process installment schedule""remind expiring credit card""send statement"

Response

application/json

{
  "billing_notice_id": "string",
  "billing_run_id": "string",
  "candidate_id": "string",
  "candidate_service": "string",
  "city": "string",
  "contact_id": "string",
  "contact_name": "string",
  "country": "string",
  "customer_id": "string",
  "customer_type": "contact",
  "date": "string",
  "email_address": "string",
  "error_message": "string",
  "error_stack": "string",
  "execution_arn": "string",
  "failed_billing_notice_id": "string",
  "first_name": "string",
  "id": "string",
  "installment_schedule_id": "string",
  "invoice_id": "string",
  "job_title": "string",
  "last_name": "string",
  "last_refresh_date": "2019-08-24T14:15:22Z",
  "name": "string",
  "order_id": "string",
  "organization_id": "string",
  "organization_name": "string",
  "outcome_of_last_refresh": "added",
  "state": "string",
  "status": "completed",
  "step_function_execution_arn": "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_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "cancel installment schedule"
}

Billing Runs

Operations

Billing Templates

Operations

Business Units

Operations

Check Request Processes

Operations

Check Request Templates

Operations

Check Requests

Operations

Cogs Entries

Operations

Credit Memos

Operations

Credits

Operations

Currency Mapping Policies

Operations

Debit Memos

Operations

Departments

Operations

Donation Products

Operations

Exchange Rates

Operations

External Payments

Operations

Fiscal Years

Operations

Gateway Entities

Operations

Gateway Entries

Operations

Gateway Fees

Operations

Gl Accounts

Operations

Installment Plans

Operations

Installment Schedules

Operations

Invoice Payment Terms

Operations

Invoice Templates

Operations

Invoice Types

Operations

Invoices

Operations

Late Fee Rules

Operations

Late Fees

Operations

Legacy Import Products

Operations

Merchant Accounts

Operations

Miscellaneous Products

Operations

Payment Receipt Templates

Operations

Payments

Operations

Product Financial Configs

Operations

Query Definitions

Operations

Recurring Batches

Operations

Recurring Billing Runs

Operations

Refund Receipt Templates

Operations

Refunds

Operations

Revenue Recognition Schedules

Operations

Settings

Operations

Statement Templates

Operations

Statements

Operations

Statistics

Operations

Stored Payment Methods

Operations

Subledger Entries

Operations

Write Offs

Operations

Accounting Projects

Bank Accounts

Batch Assignment Settings

Batch Downloading

Batch Posting

Batch Templates

Batches

Billing Notices

Billing Run Actions

Creates a new billing run action record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified billing_run_id

Request

Responses

Was this helpful?

Returns a billing run action from the system by its ID.

Request

Responses

Was this helpful?

Returns a billing run action from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a billing run action with the specified ID.

Request

Responses

Was this helpful?

Updates a billing run action with the specified ID.

RequestExpand all

Responses

Was this helpful?

Billing Runs

Billing Templates

Business Units

Check Request Processes

Check Request Templates

Check Requests

Cogs Entries

Credit Memos

Credits

Currency Mapping Policies

Debit Memos

Departments

Donation Products

Exchange Rates

External Payments

Fiscal Years

Gateway Entities

Gateway Entries

Gateway Fees

Gl Accounts

Installment Plans

Installment Schedules

Invoice Payment Terms

Invoice Templates

Invoice Types

Invoices

Late Fee Rules

Late Fees

Legacy Import Products

Merchant Accounts

Miscellaneous Products

Payment Receipt Templates

Payments

Product Financial Configs

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Refunds

Revenue Recognition Schedules

Settings

Statement Templates

Statements

Request

Request

Request