Collect

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

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/

https://collect.api.rhythmsoftware.com/

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

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

Gets all of the installment schedules in the system.

Request

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

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/installmentSchedules/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The installment scheduleswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

]

Response

application/json

[
  {
    "amount_billed": 0.1,
    "amount_outstanding": 0.1,
    "billing_address": { … },
    "business_unit_id": "string",
    "contact_id": "string",
    "currency_code": "AED",
    "date_cancelled": "2019-08-24T14:15:22Z",
    "date_last_processed": "2019-08-24T14:15:22Z",
    "date_of_last_reminder": "2019-08-24T14:15:22Z",
    "electronic_payment_info": { … },
    "entries": [ … ],
    "error_message": "string",
    "id": "string",
    "invoice_terms_id": "string",
    "merchant_account_id": "string",
    "next_processing_date": "string",
    "notes": "string",
    "number": 0.1,
    "order_process_id": "string",
    "order_type": "string",
    "organization_id": "string",
    "owner_type": "contact",
    "pay_for_credit_card_processing_fees": true,
    "remaining_number_of_installments": 0.1,
    "status": "active",
    "store_id": "string",
    "suspended_until": "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,
    "use_pro_forma_invoices": true
  }
]

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

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The installment schedule that you would like to be saved.

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/installmentSchedules/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount_billed": 0.1,
    "amount_outstanding": 0.1,
    "billing_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "business_unit_id": "string",
    "contact_id": "string",
    "currency_code": "AED",
    "date_cancelled": "2019-08-24T14:15:22Z",
    "date_last_processed": "2019-08-24T14:15:22Z",
    "date_of_last_reminder": "2019-08-24T14:15:22Z",
    "electronic_payment_info": {
      "card_expiration": "string",
      "card_type": "american express",
      "merchant_account_tokens": [
        {
          "merchant_account_id": "string",
          "token": "string"
        }
      ],
      "payment_account": "string",
      "payment_origin": "ad hoc",
      "token": "string",
      "type": "credit card"
    },
    "entries": [
      {
        "amount": 0.1,
        "billing_run_action_id": "string",
        "billing_run_id": "string",
        "date": "2019-08-24",
        "entry_id": "string",
        "installment_plan_id": null,
        "invoice_id": "string",
        "line_item_description": "string",
        "order_id": "string",
        "order_line_item_id": "string",
        "payment_id": "string",
        "perpetual_options": {
          "end_date": "string",
          "number_of_units": 1,
          "unit_of_time": "months"
        },
        "product_id": "string",
        "product_name": "string",
        "product_type": "string",
        "status": "open",
        "transient_transaction_id": null,
        "transient_transaction_type": "order",
        "type": "based on installment plan"
      }
    ],
    "error_message": "string",
    "id": "string",
    "invoice_terms_id": "string",
    "merchant_account_id": "string",
    "next_processing_date": "string",
    "notes": "string",
    "number": 0.1,
    "order_process_id": "string",
    "order_type": "string",
    "organization_id": "string",
    "owner_type": "contact",
    "pay_for_credit_card_processing_fees": true,
    "remaining_number_of_installments": 0.1,
    "status": "active",
    "store_id": "string",
    "suspended_until": "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,
    "use_pro_forma_invoices": true
  }'

Responses

The installment schedule was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

Response

application/json

{
  "amount_billed": 0.1,
  "amount_outstanding": 0.1,
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "business_unit_id": "string",
  "contact_id": "string",
  "currency_code": "AED",
  "date_cancelled": "2019-08-24T14:15:22Z",
  "date_last_processed": "2019-08-24T14:15:22Z",
  "date_of_last_reminder": "2019-08-24T14:15:22Z",
  "electronic_payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "entries": [
    { … }
  ],
  "error_message": "string",
  "id": "string",
  "invoice_terms_id": "string",
  "merchant_account_id": "string",
  "next_processing_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_process_id": "string",
  "order_type": "string",
  "organization_id": "string",
  "owner_type": "contact",
  "pay_for_credit_card_processing_fees": true,
  "remaining_number_of_installments": 0.1,
  "status": "active",
  "store_id": "string",
  "suspended_until": "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,
  "use_pro_forma_invoices": true
}

Execute Batch Operations

Request

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

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/installmentSchedules/{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 all installment schedules by order id

Request

Returns all installment schedules by order id

Path

tenantIdstringrequired

The id of the tenant being accessed

orderIdstringrequired

The ID of the order

Query

fieldsstring

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

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

Responses

The installment schedule was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

]

Response

application/json

[
  {
    "amount_billed": 0.1,
    "amount_outstanding": 0.1,
    "billing_address": { … },
    "business_unit_id": "string",
    "contact_id": "string",
    "currency_code": "AED",
    "date_cancelled": "2019-08-24T14:15:22Z",
    "date_last_processed": "2019-08-24T14:15:22Z",
    "date_of_last_reminder": "2019-08-24T14:15:22Z",
    "electronic_payment_info": { … },
    "entries": [ … ],
    "error_message": "string",
    "id": "string",
    "invoice_terms_id": "string",
    "merchant_account_id": "string",
    "next_processing_date": "string",
    "notes": "string",
    "number": 0.1,
    "order_process_id": "string",
    "order_type": "string",
    "organization_id": "string",
    "owner_type": "contact",
    "pay_for_credit_card_processing_fees": true,
    "remaining_number_of_installments": 0.1,
    "status": "active",
    "store_id": "string",
    "suspended_until": "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,
    "use_pro_forma_invoices": true
  }
]

Process Installment Schedule

Request

Will process the schedule, creating invoices/payments or orders as necessary

Path

tenantIdstringrequired

The id of the tenant being accessed

Bodyapplication/jsonrequired

The request payload

batch_idstring(Batch)required

The batch being used

billing_run_action_idstring(Billing Run Action)

If this is associated with a billing action, the information is here

billing_run_idstring(Billing Run)

The billing run

entry_idsArray of strings(Entries)required

process_bystring(Process By)

Enum"entry ids""reference date"

reference_datestring(date-time)(Reference Date)required

The reference date

schedule_idstring(Schedule)required

The schedule

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/installmentSchedules/{tenantId}/process' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batch_id": "string",
    "billing_run_action_id": "string",
    "billing_run_id": "string",
    "entry_ids": [
      "string"
    ],
    "process_by": "entry ids",
    "reference_date": "2019-08-24T14:15:22Z",
    "schedule_id": "string"
  }'

Responses

Conflicts were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

object

Response

application/json

{}

Returns a installment schedule from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the installment schedule to delete.

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

Responses

The installment schedule 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 installment schedule from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the installment schedule 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/installmentSchedules/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The installment schedule was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

Response

application/json

{
  "amount_billed": 0.1,
  "amount_outstanding": 0.1,
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "business_unit_id": "string",
  "contact_id": "string",
  "currency_code": "AED",
  "date_cancelled": "2019-08-24T14:15:22Z",
  "date_last_processed": "2019-08-24T14:15:22Z",
  "date_of_last_reminder": "2019-08-24T14:15:22Z",
  "electronic_payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "entries": [
    { … }
  ],
  "error_message": "string",
  "id": "string",
  "invoice_terms_id": "string",
  "merchant_account_id": "string",
  "next_processing_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_process_id": "string",
  "order_type": "string",
  "organization_id": "string",
  "owner_type": "contact",
  "pay_for_credit_card_processing_fees": true,
  "remaining_number_of_installments": 0.1,
  "status": "active",
  "store_id": "string",
  "suspended_until": "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,
  "use_pro_forma_invoices": true
}

Partially updates a installment schedule with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the installment schedule 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/installmentSchedules/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The installment schedule was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

Response

application/json

{
  "amount_billed": 0.1,
  "amount_outstanding": 0.1,
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "business_unit_id": "string",
  "contact_id": "string",
  "currency_code": "AED",
  "date_cancelled": "2019-08-24T14:15:22Z",
  "date_last_processed": "2019-08-24T14:15:22Z",
  "date_of_last_reminder": "2019-08-24T14:15:22Z",
  "electronic_payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "entries": [
    { … }
  ],
  "error_message": "string",
  "id": "string",
  "invoice_terms_id": "string",
  "merchant_account_id": "string",
  "next_processing_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_process_id": "string",
  "order_type": "string",
  "organization_id": "string",
  "owner_type": "contact",
  "pay_for_credit_card_processing_fees": true,
  "remaining_number_of_installments": 0.1,
  "status": "active",
  "store_id": "string",
  "suspended_until": "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,
  "use_pro_forma_invoices": true
}

Updates a installment schedule with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the installment schedule to update.

Bodyapplication/jsonrequired

The updated installment schedule that will be saved.

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/installmentSchedules/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount_billed": 0.1,
    "amount_outstanding": 0.1,
    "billing_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "business_unit_id": "string",
    "contact_id": "string",
    "currency_code": "AED",
    "date_cancelled": "2019-08-24T14:15:22Z",
    "date_last_processed": "2019-08-24T14:15:22Z",
    "date_of_last_reminder": "2019-08-24T14:15:22Z",
    "electronic_payment_info": {
      "card_expiration": "string",
      "card_type": "american express",
      "merchant_account_tokens": [
        {
          "merchant_account_id": "string",
          "token": "string"
        }
      ],
      "payment_account": "string",
      "payment_origin": "ad hoc",
      "token": "string",
      "type": "credit card"
    },
    "entries": [
      {
        "amount": 0.1,
        "billing_run_action_id": "string",
        "billing_run_id": "string",
        "date": "2019-08-24",
        "entry_id": "string",
        "installment_plan_id": null,
        "invoice_id": "string",
        "line_item_description": "string",
        "order_id": "string",
        "order_line_item_id": "string",
        "payment_id": "string",
        "perpetual_options": {
          "end_date": "string",
          "number_of_units": 1,
          "unit_of_time": "months"
        },
        "product_id": "string",
        "product_name": "string",
        "product_type": "string",
        "status": "open",
        "transient_transaction_id": null,
        "transient_transaction_type": "order",
        "type": "based on installment plan"
      }
    ],
    "error_message": "string",
    "id": "string",
    "invoice_terms_id": "string",
    "merchant_account_id": "string",
    "next_processing_date": "string",
    "notes": "string",
    "number": 0.1,
    "order_process_id": "string",
    "order_type": "string",
    "organization_id": "string",
    "owner_type": "contact",
    "pay_for_credit_card_processing_fees": true,
    "remaining_number_of_installments": 0.1,
    "status": "active",
    "store_id": "string",
    "suspended_until": "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,
    "use_pro_forma_invoices": true
  }'

Responses

The installment schedule was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

amount_billednumber(float)(Amount Billed)required

Amount of pledge fulfilled

amount_outstandingnumber(float)(Amount Outstanding)required

The amount of outstanding on the pledge

billing_addressobject(Address)

A complete address

business_unit_idstring(Business Unit)required

The business unit

contact_idstring(Contact)required

currency_codestring(Currency Code)required

The currency this schedule should be billing

Enum"AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN"

date_cancelledstring(date-time)(Date Cancelled)required

The date the schedule was cancelled

date_last_processedstring(date-time)(Date Last Processed)required

The last time this schedule was processed

date_of_last_reminderstring(date-time)(Date Of Last Reminder)

The date that the last reminder was sent for this schedule having a declined payment

electronic_payment_infoobject(Electronic Payment Info)

entriesArray of objectsnon-emptyrequired

entries[].amountnumber(double)(Amount)required

The amount of the entry

entries[].billing_run_action_idstring(Billing Run Action)

The billing run action ID last associated with this entry

entries[].billing_run_idstring(Billing Run)

The billing run ID last associated with this entry

entries[].datestring(date)(Date)required

The date of the entry

entries[].entry_idstring(Entry)required

A unique entry identifier

entries[].installment_plan_idInstallment Plan (string)(Installment Plan)

The installment plan

One of:

The installment plan

string(Installment Plan)

The installment plan

entries[].invoice_idstring(Invoice)

The invoice tied to this entry, if it has been processed

entries[].line_item_descriptionstring(Line Item Description)

Description of the line item

entries[].order_idstring(Order)

The order tied to this entry, if it has been processed and is a perpetual entry

entries[].order_line_item_idstring(Order Line Item)required

The order line item that created this schedule

entries[].payment_idstring(Payment)

The payment tied to this entry, if it has been processed

entries[].perpetual_optionsPerpetual Options (object)(Perpetual Options)

One of:

entries[].product_idstring(Product)required

The product ID

entries[].product_namestring(Product Name)required

Name of the product

entries[].product_typestring(Product Type)required

The product type

entries[].statusstring(Status)required

The status of the schedule entry

Enum"open""processed""processing"

entries[].transient_transaction_idTransient Transaction (string)(Transient Transaction)

The "transient" transaction (which may fail)

One of:

The "transient" transaction (which may fail)

string(Transient Transaction)

The "transient" transaction (which may fail)

entries[].transient_transaction_typeTransient Transaction Type (string)(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

One of:

The "transient" transaction (which may fail)

string(Transient Transaction Type)

The "transient" transaction (which may fail)

Enum"order""payment"

entries[].typestring(Type)

The type of entry

Enum"based on installment plan""perpetual"

error_messagestring(Error Message)

The last error message experienced by this schedule

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

The unique, string identifier of this installment schedule

invoice_terms_idstring(Invoice Terms)

The invoice terms

merchant_account_idstring(Merchant Account)

The merchant account being used

next_processing_datestring(Next Processing Date)

The date of next processing for this schedule

notesstring(Notes)

Any relevant notes

numbernumber(float)(Number)

Number of the plan, which should match order #

order_process_idstring(Order Process)

The process ID of the order

order_typestring(Order Type)required

Order type

organization_idstring(Organization)required

owner_typestring(Owner Type)required

Enum"contact""organization"

pay_for_credit_card_processing_feesboolean(Pay For Credit Card Processing Fees)

Whether or not we are billing for processing fees

remaining_number_of_installmentsnumber(float)(Remaining Number Of Installments)required

The number of payments remaining on the pledge

statusstring(Status)required

The status of the schedule

Enum"active""cancelled""completed""error""payment declined""suspended"

store_idstring(Store)

Store ID, if an online store

suspended_untilstring(Suspended Until)

If the schedule is suspended, the date until which it is suspended

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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether pro forma invoices should be generated

Response

application/json

{
  "amount_billed": 0.1,
  "amount_outstanding": 0.1,
  "billing_address": {
    "city": "string",
    "country": "string",
    "country_name": "string",
    "county": "string",
    "latitude": 0.1,
    "line1": "string",
    "line2": "string",
    "line3": "string",
    "longitude": 0.1,
    "postal_code": "string",
    "state": "string",
    "time_zone_id": "string"
  },
  "business_unit_id": "string",
  "contact_id": "string",
  "currency_code": "AED",
  "date_cancelled": "2019-08-24T14:15:22Z",
  "date_last_processed": "2019-08-24T14:15:22Z",
  "date_of_last_reminder": "2019-08-24T14:15:22Z",
  "electronic_payment_info": {
    "card_expiration": "string",
    "card_type": "american express",
    "merchant_account_tokens": [ … ],
    "payment_account": "string",
    "payment_origin": "ad hoc",
    "token": "string",
    "type": "credit card"
  },
  "entries": [
    { … }
  ],
  "error_message": "string",
  "id": "string",
  "invoice_terms_id": "string",
  "merchant_account_id": "string",
  "next_processing_date": "string",
  "notes": "string",
  "number": 0.1,
  "order_process_id": "string",
  "order_type": "string",
  "organization_id": "string",
  "owner_type": "contact",
  "pay_for_credit_card_processing_fees": true,
  "remaining_number_of_installments": 0.1,
  "status": "active",
  "store_id": "string",
  "suspended_until": "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,
  "use_pro_forma_invoices": true
}

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

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

Accounting Projects

Bank Accounts

Batch Assignment Settings

Batch Downloading

Batch Posting

Batch Templates

Batches

Billing Notices

Billing Run Actions

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

Gets all of the installment schedules in the system.

Request

Responses

Was this helpful?

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

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns all installment schedules by order id

Request

Responses

Was this helpful?

Process Installment Schedule

Request

Responses

Was this helpful?

Returns a installment schedule from the system by its ID.

Request

Responses

Was this helpful?

Returns a installment schedule from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a installment schedule with the specified ID.

Request

Responses

Was this helpful?

Updates a installment schedule with the specified ID.

RequestExpand all

Responses

Was this helpful?

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

Request

Request

Request