Installment Plans

Installment Plans

Creates a new installment plan record that does not already exist.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The installment plan that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this installment plan

name
required
string (Name)

The name of the installment plan

amount_due_up_front
number <double> (Amount Due Up Front)

The amount to charge up front in the installment plan

percentage_due_up_front
number <double> (Percentage Due Up Front)

The percentage to charge up front in the installment plan

type
required
string (Type)
Enum: "fixed installments" "exact dates" "relative dates"
required
object (Fixed Installments)
required
Array of objects [ 1 .. 100 ] items
required
Array of objects [ 1 .. 100 ] items
is_active
boolean (Is Active)

Whether or not the installment plan is active

description
string (Description)

Description of the plan

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

Responses
200The installment plan was saved successfully.
400The installment plan you supplied was invalid.
401Unauthorized.
403Forbidden.
409The installment plan could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add installment plan based on tenant limits.
500General server error.
post/installmentPlans/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "amount_due_up_front": 0,
  • "percentage_due_up_front": 0,
  • "type": "fixed installments",
  • "fixed_installments": {
    },
  • "exact_dates": [
    ],
  • "relative_dates": [
    ],
  • "is_active": true,
  • "description": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "amount_due_up_front": 0,
  • "percentage_due_up_front": 0,
  • "type": "fixed installments",
  • "fixed_installments": {
    },
  • "exact_dates": [
    ],
  • "relative_dates": [
    ],
  • "is_active": true,
  • "description": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Gets all of the installment plans in the system.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The installment planswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/installmentPlans/{tenantId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/installmentPlans/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a installment plan from the system by its ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the installment plan to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The installment plan was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The installment plan could not be found.
429Limit exceeded... unable to retrieve installment plan based on tenant limits.
500General server error.
get/installmentPlans/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/installmentPlans/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "amount_due_up_front": 0,
  • "percentage_due_up_front": 0,
  • "type": "fixed installments",
  • "fixed_installments": {
    },
  • "exact_dates": [
    ],
  • "relative_dates": [
    ],
  • "is_active": true,
  • "description": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Updates a installment plan with the specified ID.

This method will update an existing installment plan with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the installment plan to update.

Request Body schema: application/json

The updated installment plan that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this installment plan

name
required
string (Name)

The name of the installment plan

amount_due_up_front
number <double> (Amount Due Up Front)

The amount to charge up front in the installment plan

percentage_due_up_front
number <double> (Percentage Due Up Front)

The percentage to charge up front in the installment plan

type
required
string (Type)
Enum: "fixed installments" "exact dates" "relative dates"
required
object (Fixed Installments)
required
Array of objects [ 1 .. 100 ] items
required
Array of objects [ 1 .. 100 ] items
is_active
boolean (Is Active)

Whether or not the installment plan is active

description
string (Description)

Description of the plan

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

Responses
200The installment plan was updated successfully.
400The installment plan supplied was not valid.
401Unauthorized.
403Forbidden.
404The installment plan could not be found.
409The installment plan could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve installment plan based on tenant limits.
500General server error.
put/installmentPlans/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "amount_due_up_front": 0,
  • "percentage_due_up_front": 0,
  • "type": "fixed installments",
  • "fixed_installments": {
    },
  • "exact_dates": [
    ],
  • "relative_dates": [
    ],
  • "is_active": true,
  • "description": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "amount_due_up_front": 0,
  • "percentage_due_up_front": 0,
  • "type": "fixed installments",
  • "fixed_installments": {
    },
  • "exact_dates": [
    ],
  • "relative_dates": [
    ],
  • "is_active": true,
  • "description": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Partially updates a installment plan with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the installment plan to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The installment plan was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The installment plan could not be found.
409The installment plan could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve installment plan based on tenant limits.
500General server error.
patch/installmentPlans/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "amount_due_up_front": 0,
  • "percentage_due_up_front": 0,
  • "type": "fixed installments",
  • "fixed_installments": {
    },
  • "exact_dates": [
    ],
  • "relative_dates": [
    ],
  • "is_active": true,
  • "description": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Returns a installment plan from the system by its ID.

This method will delete a installment plan with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the installment plan to delete.

Responses
200The installment plan was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The installment plan could not be found.
409The installment plan could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete installment plan based on tenant limits.
500General server error.
delete/installmentPlans/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://collect.api.rhythmsoftware.com/installmentPlans/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"