Collect

Returns a product financial config from the system by its ID.

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

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

Gets all of the product financial configs in the system.

Request

This method will scan all product financial configs 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/productFinancialConfigs/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The product financial configswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

]

Response

application/json

[
  {
    "accounting_project_id": "string",
    "accounts_receivable_gl_account_id": "string",
    "business_unit_id": "string",
    "cogs_expense_gl_account_id": "string",
    "custom_field_values": [ … ],
    "deferral_fixed_dates": [ … ],
    "deferral_schedule_calculation_strategy": "automatic",
    "deferred_revenue_gl_account_id": "string",
    "department_id": "string",
    "due_to_due_from_entries": [ … ],
    "enable_deferred_revenue_recognition": true,
    "enable_revenue_splits": true,
    "id": "string",
    "inventory_gl_account_id": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "product_id": "string",
    "product_type": "string",
    "revenue_gl_account_id": "string",
    "revenue_splits": [ … ],
    "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,
    "tax_class_id": "string",
    "write_off_gl_account_id": "string"
  }
]

Creates a new product financial config record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The product financial config that you would like to be saved.

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/productFinancialConfigs/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accounting_project_id": "string",
    "accounts_receivable_gl_account_id": "string",
    "business_unit_id": "string",
    "cogs_expense_gl_account_id": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "deferral_fixed_dates": [
      {
        "date": "2019-08-24T14:15:22Z",
        "percentage": 100
      }
    ],
    "deferral_schedule_calculation_strategy": "automatic",
    "deferred_revenue_gl_account_id": "string",
    "department_id": "string",
    "due_to_due_from_entries": [
      {
        "accounts_receivable_gl_account_id": "string",
        "business_unit_id": "string",
        "liability_gl_account_id": "string"
      }
    ],
    "enable_deferred_revenue_recognition": true,
    "enable_revenue_splits": true,
    "id": "string",
    "inventory_gl_account_id": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "product_id": "string",
    "product_type": "string",
    "revenue_gl_account_id": "string",
    "revenue_splits": [
      {
        "amount": null,
        "name": "string",
        "percentage": null,
        "revenue_gl_account_id": "string",
        "revenue_split_id": "string",
        "type": "fixed amount"
      }
    ],
    "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,
    "tax_class_id": "string",
    "write_off_gl_account_id": "string"
  }'

Responses

The product financial config was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

Response

application/json

{
  "accounting_project_id": "string",
  "accounts_receivable_gl_account_id": "string",
  "business_unit_id": "string",
  "cogs_expense_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "deferral_fixed_dates": [
    { … }
  ],
  "deferral_schedule_calculation_strategy": "automatic",
  "deferred_revenue_gl_account_id": "string",
  "department_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_deferred_revenue_recognition": true,
  "enable_revenue_splits": true,
  "id": "string",
  "inventory_gl_account_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "product_id": "string",
  "product_type": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "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,
  "tax_class_id": "string",
  "write_off_gl_account_id": "string"
}

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/productFinancialConfigs/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Returns a product financial configs from the system by its product type/ID.

Request

This method will look up a product financial configs by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed

productTypestringrequired

The type of product

productIdstringrequired

The ID of the product to return

Query

fieldsstring

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

consistentReadboolean

If set to true, a consistent read operation will be executed which is guaranteed to return latest results

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

Responses

The product financial configuration was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

Response

application/json

{
  "accounting_project_id": "string",
  "accounts_receivable_gl_account_id": "string",
  "business_unit_id": "string",
  "cogs_expense_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "deferral_fixed_dates": [
    { … }
  ],
  "deferral_schedule_calculation_strategy": "automatic",
  "deferred_revenue_gl_account_id": "string",
  "department_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_deferred_revenue_recognition": true,
  "enable_revenue_splits": true,
  "id": "string",
  "inventory_gl_account_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "product_id": "string",
  "product_type": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "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,
  "tax_class_id": "string",
  "write_off_gl_account_id": "string"
}

Returns a product financial config from the system by its ID.

Request

This method will delete a product financial config with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the product financial config to delete.

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

Responses

The product financial config 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 product financial config from the system by its ID.

Request

This method will look up a product financial config by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The product financial config was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

Response

application/json

{
  "accounting_project_id": "string",
  "accounts_receivable_gl_account_id": "string",
  "business_unit_id": "string",
  "cogs_expense_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "deferral_fixed_dates": [
    { … }
  ],
  "deferral_schedule_calculation_strategy": "automatic",
  "deferred_revenue_gl_account_id": "string",
  "department_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_deferred_revenue_recognition": true,
  "enable_revenue_splits": true,
  "id": "string",
  "inventory_gl_account_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "product_id": "string",
  "product_type": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "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,
  "tax_class_id": "string",
  "write_off_gl_account_id": "string"
}

Partially updates a product financial config with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The product financial config was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

Response

application/json

{
  "accounting_project_id": "string",
  "accounts_receivable_gl_account_id": "string",
  "business_unit_id": "string",
  "cogs_expense_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "deferral_fixed_dates": [
    { … }
  ],
  "deferral_schedule_calculation_strategy": "automatic",
  "deferred_revenue_gl_account_id": "string",
  "department_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_deferred_revenue_recognition": true,
  "enable_revenue_splits": true,
  "id": "string",
  "inventory_gl_account_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "product_id": "string",
  "product_type": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "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,
  "tax_class_id": "string",
  "write_off_gl_account_id": "string"
}

Updates a product financial config with the specified ID.

Request

This method will update an existing product financial config with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the product financial config to update.

Bodyapplication/jsonrequired

The updated product financial config that will be saved.

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/productFinancialConfigs/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accounting_project_id": "string",
    "accounts_receivable_gl_account_id": "string",
    "business_unit_id": "string",
    "cogs_expense_gl_account_id": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "deferral_fixed_dates": [
      {
        "date": "2019-08-24T14:15:22Z",
        "percentage": 100
      }
    ],
    "deferral_schedule_calculation_strategy": "automatic",
    "deferred_revenue_gl_account_id": "string",
    "department_id": "string",
    "due_to_due_from_entries": [
      {
        "accounts_receivable_gl_account_id": "string",
        "business_unit_id": "string",
        "liability_gl_account_id": "string"
      }
    ],
    "enable_deferred_revenue_recognition": true,
    "enable_revenue_splits": true,
    "id": "string",
    "inventory_gl_account_id": "string",
    "merchant_account_id": "string",
    "notes": "string",
    "product_id": "string",
    "product_type": "string",
    "revenue_gl_account_id": "string",
    "revenue_splits": [
      {
        "amount": null,
        "name": "string",
        "percentage": null,
        "revenue_gl_account_id": "string",
        "revenue_split_id": "string",
        "type": "fixed amount"
      }
    ],
    "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,
    "tax_class_id": "string",
    "write_off_gl_account_id": "string"
  }'

Responses

The product financial config was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_project_idstring(Accounting Project)

The accounting project for this project

accounts_receivable_gl_account_idstring(Accounts Receivable Gl Account)

The A/R GL account

business_unit_idstring(Business Unit)required

The business unit id

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The COGS account

custom_field_valuesArray of objects(Custom Field Values)

deferral_fixed_datesArray of objectsnon-emptyrequired

deferral_fixed_dates[].datestring(date-time)(Date)

The date for deferral

deferral_fixed_dates[].percentagenumber(double)(Percentage)[ 0 .. 100 ]

The percentage to defer

deferral_schedule_calculation_strategystring(Deferral Schedule Calculation Strategy)

How the revenue recognition schedule is calculated

Enum"automatic""fixed dates"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)required

The deferred revenue account

department_idstring(Department)

The department for this project

due_to_due_from_entriesArray of objectsnon-empty

enable_deferred_revenue_recognitionboolean(Enable Deferred Revenue Recognition)

Whether or not revenue should be deferred

enable_revenue_splitsboolean(Enable Revenue Splits)

Whether or not the product should split revenue

idstring(ID)^[\w\-_\s,&@\.\\|]+$required

The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]

inventory_gl_account_idstring(Inventory Gl Account)

The inventory gl account

merchant_account_idstring(Merchant Account)

The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account

notesstring(Notes)

notes

product_idstring(Product)required

The id of product

product_typestring(Product Type)required

The type of product

revenue_gl_account_idstring(Revenue Gl Account)required

The revenue GL account

revenue_splitsArray of objectsnon-emptyrequired

revenue_splits[].amountAmount (number)(double)(Amount)>= 0

One of:

>= 0

number(double)(Amount)>= 0

revenue_splits[].namestring(Name)

revenue_splits[].percentagePercentage (number)(double)(Percentage)[ 0 .. 100 ]

One of:

[ 0 .. 100 ]

number(double)(Percentage)[ 0 .. 100 ]

revenue_splits[].revenue_gl_account_idstring(Revenue Gl Account)

The revenue account id

revenue_splits[].revenue_split_idstring(Revenue Split)

revenue_splits[].typestring(Type)

Enum"fixed amount""percentage"

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

tax_class_idstring(Tax Class)

The tax class of this product

write_off_gl_account_idstring(Write Off Gl Account)

The write off account

Response

application/json

{
  "accounting_project_id": "string",
  "accounts_receivable_gl_account_id": "string",
  "business_unit_id": "string",
  "cogs_expense_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "deferral_fixed_dates": [
    { … }
  ],
  "deferral_schedule_calculation_strategy": "automatic",
  "deferred_revenue_gl_account_id": "string",
  "department_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_deferred_revenue_recognition": true,
  "enable_revenue_splits": true,
  "id": "string",
  "inventory_gl_account_id": "string",
  "merchant_account_id": "string",
  "notes": "string",
  "product_id": "string",
  "product_type": "string",
  "revenue_gl_account_id": "string",
  "revenue_splits": [
    { … }
  ],
  "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,
  "tax_class_id": "string",
  "write_off_gl_account_id": "string"
}

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

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

Gets all of the product financial configs in the system.

Request

Responses

Was this helpful?

Creates a new product financial config record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a product financial configs from the system by its product type/ID.

Request

Responses

Was this helpful?

Returns a product financial config from the system by its ID.

Request

Responses

Was this helpful?

Returns a product financial config from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a product financial config with the specified ID.

Request

Responses

Was this helpful?

Updates a product financial config with the specified ID.

RequestExpand all

Responses

Was this helpful?

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Request

Request

Request