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

Gets all of the business units in the system.

Request

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

Responses

The business unitswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

accounting_methodstring(Accounting Method)

The accounting method for generating subledger entries

Enum"accrual""cash"

ar_gl_account_idstring(Ar Gl Account)

The default A/R account

automatic_batch_download_optionsobject(Automatic Batch Download Options)required

automatic_batch_download_options.accounting_integration_account_idstring(Accounting Integration Account)required

The ID of the accounting integration service

automatic_batch_download_options.accounting_integration_servicestring(Accounting Integration Service)required

Value"integration-qbo-accounts"

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

The default A/R account

base_currency_codestring(Base Currency Code)= 3 charactersrequired

The base currency for the business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the business unit

batch_download_methodstring(Batch Download Method)required

Enum"batch-level summary""detail""summary"

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The default COGS expense account

currency_trading_gl_account_idstring(Currency Trading Gl Account)

The default A/R account

custom_field_valuesArray of objects(Custom Field Values)

default_write_off_methodstring(Default Write Off Method)required

Enum"allowance""direct"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)

The default A/R account

descriptionstring(Description)

Any descriptive information about the business unit

download_template_idstring(Download Template)

The optional template to use to format the financial download file

due_to_due_from_entriesArray of objectsnon-empty

enable_automatic_batch_downloadsboolean(Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

enable_multi_currencyboolean(Enable Multi Currency)

Whether or not multi-currency is turned on for this business unit

financial_software_packagestring(Financial Software Package)

Enum"great plains""netsuite""other""peachtree""quickbooks""quickbooks online""sage intacct"

idstring(ID)^\w+$required

The unique, string identifier of this business unit

inventory_costing_methodstring(Inventory Costing Method)required

Enum"do not calculate""fifo""lifo"

inventory_gl_account_idstring(Inventory Gl Account)

The default A/R account

invoice_template_idstring(Invoice Template)

Teh default invoice template to use for printing invoices

is_activeboolean(Is Active)

Whether or not this business unit is active

missing_product_revenue_gl_account_idstring(Missing Product Revenue Gl Account)

The G/L account for missing products

namestring(Name)required

The name of the business unit

overpayment_liability_gl_account_idstring(Overpayment Liability Gl Account)

The default A/R account

payment_receipt_emailobject(Payment Receipt Email)

payment_receipt_template_idstring(Payment Receipt Template)

Teh default payment template to use for printing payment receipts

prioritynumber(float)(Priority)

A priority number that determines how this is displayed; lower numbers indicate higher priority

quickbooks_online_account_idstring(Quickbooks Online Account)

The quickbooks online account tied to the business unit

refund_receipt_emailobject(Refund Receipt Email)

refund_receipt_template_idstring(Refund Receipt Template)

Teh default template to use for printing refund receipts

start_of_fiscal_yearinteger(Start Of Fiscal Year)[ 1 .. 12 ]required

The starting month of the fiscal year, between 1-12

store_credit_gl_account_idstring(Store Credit Gl Account)

The default A/R account

supported_currenciesArray of objectsnon-emptyrequired

supported_currencies[].currency_codestring(Currency Code)= 3 charactersrequired

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

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

]

Response

application/json

[
  {
    "accounting_method": "accrual",
    "ar_gl_account_id": "string",
    "automatic_batch_download_options": { … },
    "bad_debts_expense_gl_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_download_method": "batch-level summary",
    "cogs_expense_gl_account_id": "string",
    "currency_trading_gl_account_id": "string",
    "custom_field_values": [ … ],
    "default_write_off_method": "allowance",
    "deferred_revenue_gl_account_id": "string",
    "description": "string",
    "download_template_id": "string",
    "due_to_due_from_entries": [ … ],
    "enable_automatic_batch_downloads": true,
    "enable_multi_currency": true,
    "financial_software_package": "great plains",
    "id": "string",
    "inventory_costing_method": "do not calculate",
    "inventory_gl_account_id": "string",
    "invoice_template_id": "string",
    "is_active": true,
    "missing_product_revenue_gl_account_id": "string",
    "name": "string",
    "overpayment_liability_gl_account_id": "string",
    "payment_receipt_email": { … },
    "payment_receipt_template_id": "string",
    "priority": 0.1,
    "quickbooks_online_account_id": "string",
    "refund_receipt_email": { … },
    "refund_receipt_template_id": "string",
    "start_of_fiscal_year": 1,
    "store_credit_gl_account_id": "string",
    "supported_currencies": [ … ],
    "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
  }
]

Creates a new business unit record that does not already exist.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The business unit that you would like to be saved.

accounting_methodstring(Accounting Method)

The accounting method for generating subledger entries

Enum"accrual""cash"

ar_gl_account_idstring(Ar Gl Account)

The default A/R account

automatic_batch_download_optionsobject(Automatic Batch Download Options)required

automatic_batch_download_options.accounting_integration_account_idstring(Accounting Integration Account)required

The ID of the accounting integration service

automatic_batch_download_options.accounting_integration_servicestring(Accounting Integration Service)required

Value"integration-qbo-accounts"

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

The default A/R account

base_currency_codestring(Base Currency Code)= 3 charactersrequired

The base currency for the business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the business unit

batch_download_methodstring(Batch Download Method)required

Enum"batch-level summary""detail""summary"

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The default COGS expense account

currency_trading_gl_account_idstring(Currency Trading Gl Account)

The default A/R account

custom_field_valuesArray of objects(Custom Field Values)

default_write_off_methodstring(Default Write Off Method)required

Enum"allowance""direct"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)

The default A/R account

descriptionstring(Description)

Any descriptive information about the business unit

download_template_idstring(Download Template)

The optional template to use to format the financial download file

due_to_due_from_entriesArray of objectsnon-empty

enable_automatic_batch_downloadsboolean(Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

enable_multi_currencyboolean(Enable Multi Currency)

Whether or not multi-currency is turned on for this business unit

financial_software_packagestring(Financial Software Package)

Enum"great plains""netsuite""other""peachtree""quickbooks""quickbooks online""sage intacct"

idstring(ID)^\w+$required

The unique, string identifier of this business unit

inventory_costing_methodstring(Inventory Costing Method)required

Enum"do not calculate""fifo""lifo"

inventory_gl_account_idstring(Inventory Gl Account)

The default A/R account

invoice_template_idstring(Invoice Template)

Teh default invoice template to use for printing invoices

is_activeboolean(Is Active)

Whether or not this business unit is active

missing_product_revenue_gl_account_idstring(Missing Product Revenue Gl Account)

The G/L account for missing products

namestring(Name)required

The name of the business unit

overpayment_liability_gl_account_idstring(Overpayment Liability Gl Account)

The default A/R account

payment_receipt_emailobject(Payment Receipt Email)

payment_receipt_template_idstring(Payment Receipt Template)

Teh default payment template to use for printing payment receipts

prioritynumber(float)(Priority)

A priority number that determines how this is displayed; lower numbers indicate higher priority

quickbooks_online_account_idstring(Quickbooks Online Account)

The quickbooks online account tied to the business unit

refund_receipt_emailobject(Refund Receipt Email)

refund_receipt_template_idstring(Refund Receipt Template)

Teh default template to use for printing refund receipts

start_of_fiscal_yearinteger(Start Of Fiscal Year)[ 1 .. 12 ]required

The starting month of the fiscal year, between 1-12

store_credit_gl_account_idstring(Store Credit Gl Account)

The default A/R account

supported_currenciesArray of objectsnon-emptyrequired

supported_currencies[].currency_codestring(Currency Code)= 3 charactersrequired

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

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

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/businessUnits/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accounting_method": "accrual",
    "ar_gl_account_id": "string",
    "automatic_batch_download_options": {
      "accounting_integration_account_id": "string",
      "accounting_integration_service": "integration-qbo-accounts"
    },
    "bad_debts_expense_gl_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_download_method": "batch-level summary",
    "cogs_expense_gl_account_id": "string",
    "currency_trading_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": [
          {}
        ]
      }
    ],
    "default_write_off_method": "allowance",
    "deferred_revenue_gl_account_id": "string",
    "description": "string",
    "download_template_id": "string",
    "due_to_due_from_entries": [
      {
        "accounts_receivable_gl_account_id": "string",
        "business_unit_id": "string",
        "liability_gl_account_id": "string"
      }
    ],
    "enable_automatic_batch_downloads": true,
    "enable_multi_currency": true,
    "financial_software_package": "great plains",
    "id": "string",
    "inventory_costing_method": "do not calculate",
    "inventory_gl_account_id": "string",
    "invoice_template_id": "string",
    "is_active": true,
    "missing_product_revenue_gl_account_id": "string",
    "name": "string",
    "overpayment_liability_gl_account_id": "string",
    "payment_receipt_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "payment_receipt_template_id": "string",
    "priority": 0.1,
    "quickbooks_online_account_id": "string",
    "refund_receipt_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "refund_receipt_template_id": "string",
    "start_of_fiscal_year": 1,
    "store_credit_gl_account_id": "string",
    "supported_currencies": [
      {
        "currency_code": "AED"
      }
    ],
    "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
  }'

Responses

The business unit was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_methodstring(Accounting Method)

The accounting method for generating subledger entries

Enum"accrual""cash"

ar_gl_account_idstring(Ar Gl Account)

The default A/R account

automatic_batch_download_optionsobject(Automatic Batch Download Options)required

automatic_batch_download_options.accounting_integration_account_idstring(Accounting Integration Account)required

The ID of the accounting integration service

automatic_batch_download_options.accounting_integration_servicestring(Accounting Integration Service)required

Value"integration-qbo-accounts"

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

The default A/R account

base_currency_codestring(Base Currency Code)= 3 charactersrequired

The base currency for the business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the business unit

batch_download_methodstring(Batch Download Method)required

Enum"batch-level summary""detail""summary"

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The default COGS expense account

currency_trading_gl_account_idstring(Currency Trading Gl Account)

The default A/R account

custom_field_valuesArray of objects(Custom Field Values)

default_write_off_methodstring(Default Write Off Method)required

Enum"allowance""direct"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)

The default A/R account

descriptionstring(Description)

Any descriptive information about the business unit

download_template_idstring(Download Template)

The optional template to use to format the financial download file

due_to_due_from_entriesArray of objectsnon-empty

enable_automatic_batch_downloadsboolean(Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

enable_multi_currencyboolean(Enable Multi Currency)

Whether or not multi-currency is turned on for this business unit

financial_software_packagestring(Financial Software Package)

Enum"great plains""netsuite""other""peachtree""quickbooks""quickbooks online""sage intacct"

idstring(ID)^\w+$required

The unique, string identifier of this business unit

inventory_costing_methodstring(Inventory Costing Method)required

Enum"do not calculate""fifo""lifo"

inventory_gl_account_idstring(Inventory Gl Account)

The default A/R account

invoice_template_idstring(Invoice Template)

Teh default invoice template to use for printing invoices

is_activeboolean(Is Active)

Whether or not this business unit is active

missing_product_revenue_gl_account_idstring(Missing Product Revenue Gl Account)

The G/L account for missing products

namestring(Name)required

The name of the business unit

overpayment_liability_gl_account_idstring(Overpayment Liability Gl Account)

The default A/R account

payment_receipt_emailobject(Payment Receipt Email)

payment_receipt_template_idstring(Payment Receipt Template)

Teh default payment template to use for printing payment receipts

prioritynumber(float)(Priority)

A priority number that determines how this is displayed; lower numbers indicate higher priority

quickbooks_online_account_idstring(Quickbooks Online Account)

The quickbooks online account tied to the business unit

refund_receipt_emailobject(Refund Receipt Email)

refund_receipt_template_idstring(Refund Receipt Template)

Teh default template to use for printing refund receipts

start_of_fiscal_yearinteger(Start Of Fiscal Year)[ 1 .. 12 ]required

The starting month of the fiscal year, between 1-12

store_credit_gl_account_idstring(Store Credit Gl Account)

The default A/R account

supported_currenciesArray of objectsnon-emptyrequired

supported_currencies[].currency_codestring(Currency Code)= 3 charactersrequired

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

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

Response

application/json

{
  "accounting_method": "accrual",
  "ar_gl_account_id": "string",
  "automatic_batch_download_options": {
    "accounting_integration_account_id": "string",
    "accounting_integration_service": "integration-qbo-accounts"
  },
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_download_method": "batch-level summary",
  "cogs_expense_gl_account_id": "string",
  "currency_trading_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "default_write_off_method": "allowance",
  "deferred_revenue_gl_account_id": "string",
  "description": "string",
  "download_template_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_automatic_batch_downloads": true,
  "enable_multi_currency": true,
  "financial_software_package": "great plains",
  "id": "string",
  "inventory_costing_method": "do not calculate",
  "inventory_gl_account_id": "string",
  "invoice_template_id": "string",
  "is_active": true,
  "missing_product_revenue_gl_account_id": "string",
  "name": "string",
  "overpayment_liability_gl_account_id": "string",
  "payment_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "payment_receipt_template_id": "string",
  "priority": 0.1,
  "quickbooks_online_account_id": "string",
  "refund_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "refund_receipt_template_id": "string",
  "start_of_fiscal_year": 1,
  "store_credit_gl_account_id": "string",
  "supported_currencies": [
    { … }
  ],
  "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
}

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/businessUnits/{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 business unit from the system by its ID.

Request

This method will delete a business unit with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the business unit to delete.

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

Responses

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

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The business unit was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_methodstring(Accounting Method)

The accounting method for generating subledger entries

Enum"accrual""cash"

ar_gl_account_idstring(Ar Gl Account)

The default A/R account

automatic_batch_download_optionsobject(Automatic Batch Download Options)required

automatic_batch_download_options.accounting_integration_account_idstring(Accounting Integration Account)required

The ID of the accounting integration service

automatic_batch_download_options.accounting_integration_servicestring(Accounting Integration Service)required

Value"integration-qbo-accounts"

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

The default A/R account

base_currency_codestring(Base Currency Code)= 3 charactersrequired

The base currency for the business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the business unit

batch_download_methodstring(Batch Download Method)required

Enum"batch-level summary""detail""summary"

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The default COGS expense account

currency_trading_gl_account_idstring(Currency Trading Gl Account)

The default A/R account

custom_field_valuesArray of objects(Custom Field Values)

default_write_off_methodstring(Default Write Off Method)required

Enum"allowance""direct"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)

The default A/R account

descriptionstring(Description)

Any descriptive information about the business unit

download_template_idstring(Download Template)

The optional template to use to format the financial download file

due_to_due_from_entriesArray of objectsnon-empty

enable_automatic_batch_downloadsboolean(Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

enable_multi_currencyboolean(Enable Multi Currency)

Whether or not multi-currency is turned on for this business unit

financial_software_packagestring(Financial Software Package)

Enum"great plains""netsuite""other""peachtree""quickbooks""quickbooks online""sage intacct"

idstring(ID)^\w+$required

The unique, string identifier of this business unit

inventory_costing_methodstring(Inventory Costing Method)required

Enum"do not calculate""fifo""lifo"

inventory_gl_account_idstring(Inventory Gl Account)

The default A/R account

invoice_template_idstring(Invoice Template)

Teh default invoice template to use for printing invoices

is_activeboolean(Is Active)

Whether or not this business unit is active

missing_product_revenue_gl_account_idstring(Missing Product Revenue Gl Account)

The G/L account for missing products

namestring(Name)required

The name of the business unit

overpayment_liability_gl_account_idstring(Overpayment Liability Gl Account)

The default A/R account

payment_receipt_emailobject(Payment Receipt Email)

payment_receipt_template_idstring(Payment Receipt Template)

Teh default payment template to use for printing payment receipts

prioritynumber(float)(Priority)

A priority number that determines how this is displayed; lower numbers indicate higher priority

quickbooks_online_account_idstring(Quickbooks Online Account)

The quickbooks online account tied to the business unit

refund_receipt_emailobject(Refund Receipt Email)

refund_receipt_template_idstring(Refund Receipt Template)

Teh default template to use for printing refund receipts

start_of_fiscal_yearinteger(Start Of Fiscal Year)[ 1 .. 12 ]required

The starting month of the fiscal year, between 1-12

store_credit_gl_account_idstring(Store Credit Gl Account)

The default A/R account

supported_currenciesArray of objectsnon-emptyrequired

supported_currencies[].currency_codestring(Currency Code)= 3 charactersrequired

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

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

Response

application/json

{
  "accounting_method": "accrual",
  "ar_gl_account_id": "string",
  "automatic_batch_download_options": {
    "accounting_integration_account_id": "string",
    "accounting_integration_service": "integration-qbo-accounts"
  },
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_download_method": "batch-level summary",
  "cogs_expense_gl_account_id": "string",
  "currency_trading_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "default_write_off_method": "allowance",
  "deferred_revenue_gl_account_id": "string",
  "description": "string",
  "download_template_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_automatic_batch_downloads": true,
  "enable_multi_currency": true,
  "financial_software_package": "great plains",
  "id": "string",
  "inventory_costing_method": "do not calculate",
  "inventory_gl_account_id": "string",
  "invoice_template_id": "string",
  "is_active": true,
  "missing_product_revenue_gl_account_id": "string",
  "name": "string",
  "overpayment_liability_gl_account_id": "string",
  "payment_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "payment_receipt_template_id": "string",
  "priority": 0.1,
  "quickbooks_online_account_id": "string",
  "refund_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "refund_receipt_template_id": "string",
  "start_of_fiscal_year": 1,
  "store_credit_gl_account_id": "string",
  "supported_currencies": [
    { … }
  ],
  "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
}

Partially updates a business unit with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The business unit was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_methodstring(Accounting Method)

The accounting method for generating subledger entries

Enum"accrual""cash"

ar_gl_account_idstring(Ar Gl Account)

The default A/R account

automatic_batch_download_optionsobject(Automatic Batch Download Options)required

automatic_batch_download_options.accounting_integration_account_idstring(Accounting Integration Account)required

The ID of the accounting integration service

automatic_batch_download_options.accounting_integration_servicestring(Accounting Integration Service)required

Value"integration-qbo-accounts"

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

The default A/R account

base_currency_codestring(Base Currency Code)= 3 charactersrequired

The base currency for the business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the business unit

batch_download_methodstring(Batch Download Method)required

Enum"batch-level summary""detail""summary"

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The default COGS expense account

currency_trading_gl_account_idstring(Currency Trading Gl Account)

The default A/R account

custom_field_valuesArray of objects(Custom Field Values)

default_write_off_methodstring(Default Write Off Method)required

Enum"allowance""direct"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)

The default A/R account

descriptionstring(Description)

Any descriptive information about the business unit

download_template_idstring(Download Template)

The optional template to use to format the financial download file

due_to_due_from_entriesArray of objectsnon-empty

enable_automatic_batch_downloadsboolean(Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

enable_multi_currencyboolean(Enable Multi Currency)

Whether or not multi-currency is turned on for this business unit

financial_software_packagestring(Financial Software Package)

Enum"great plains""netsuite""other""peachtree""quickbooks""quickbooks online""sage intacct"

idstring(ID)^\w+$required

The unique, string identifier of this business unit

inventory_costing_methodstring(Inventory Costing Method)required

Enum"do not calculate""fifo""lifo"

inventory_gl_account_idstring(Inventory Gl Account)

The default A/R account

invoice_template_idstring(Invoice Template)

Teh default invoice template to use for printing invoices

is_activeboolean(Is Active)

Whether or not this business unit is active

missing_product_revenue_gl_account_idstring(Missing Product Revenue Gl Account)

The G/L account for missing products

namestring(Name)required

The name of the business unit

overpayment_liability_gl_account_idstring(Overpayment Liability Gl Account)

The default A/R account

payment_receipt_emailobject(Payment Receipt Email)

payment_receipt_template_idstring(Payment Receipt Template)

Teh default payment template to use for printing payment receipts

prioritynumber(float)(Priority)

A priority number that determines how this is displayed; lower numbers indicate higher priority

quickbooks_online_account_idstring(Quickbooks Online Account)

The quickbooks online account tied to the business unit

refund_receipt_emailobject(Refund Receipt Email)

refund_receipt_template_idstring(Refund Receipt Template)

Teh default template to use for printing refund receipts

start_of_fiscal_yearinteger(Start Of Fiscal Year)[ 1 .. 12 ]required

The starting month of the fiscal year, between 1-12

store_credit_gl_account_idstring(Store Credit Gl Account)

The default A/R account

supported_currenciesArray of objectsnon-emptyrequired

supported_currencies[].currency_codestring(Currency Code)= 3 charactersrequired

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

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

Response

application/json

{
  "accounting_method": "accrual",
  "ar_gl_account_id": "string",
  "automatic_batch_download_options": {
    "accounting_integration_account_id": "string",
    "accounting_integration_service": "integration-qbo-accounts"
  },
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_download_method": "batch-level summary",
  "cogs_expense_gl_account_id": "string",
  "currency_trading_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "default_write_off_method": "allowance",
  "deferred_revenue_gl_account_id": "string",
  "description": "string",
  "download_template_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_automatic_batch_downloads": true,
  "enable_multi_currency": true,
  "financial_software_package": "great plains",
  "id": "string",
  "inventory_costing_method": "do not calculate",
  "inventory_gl_account_id": "string",
  "invoice_template_id": "string",
  "is_active": true,
  "missing_product_revenue_gl_account_id": "string",
  "name": "string",
  "overpayment_liability_gl_account_id": "string",
  "payment_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "payment_receipt_template_id": "string",
  "priority": 0.1,
  "quickbooks_online_account_id": "string",
  "refund_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "refund_receipt_template_id": "string",
  "start_of_fiscal_year": 1,
  "store_credit_gl_account_id": "string",
  "supported_currencies": [
    { … }
  ],
  "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
}

Updates a business unit with the specified ID.

Request

This method will update an existing business unit with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the business unit to update.

Bodyapplication/jsonrequired

The updated business unit that will be saved.

accounting_methodstring(Accounting Method)

The accounting method for generating subledger entries

Enum"accrual""cash"

ar_gl_account_idstring(Ar Gl Account)

The default A/R account

automatic_batch_download_optionsobject(Automatic Batch Download Options)required

automatic_batch_download_options.accounting_integration_account_idstring(Accounting Integration Account)required

The ID of the accounting integration service

automatic_batch_download_options.accounting_integration_servicestring(Accounting Integration Service)required

Value"integration-qbo-accounts"

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

The default A/R account

base_currency_codestring(Base Currency Code)= 3 charactersrequired

The base currency for the business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the business unit

batch_download_methodstring(Batch Download Method)required

Enum"batch-level summary""detail""summary"

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The default COGS expense account

currency_trading_gl_account_idstring(Currency Trading Gl Account)

The default A/R account

custom_field_valuesArray of objects(Custom Field Values)

default_write_off_methodstring(Default Write Off Method)required

Enum"allowance""direct"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)

The default A/R account

descriptionstring(Description)

Any descriptive information about the business unit

download_template_idstring(Download Template)

The optional template to use to format the financial download file

due_to_due_from_entriesArray of objectsnon-empty

enable_automatic_batch_downloadsboolean(Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

enable_multi_currencyboolean(Enable Multi Currency)

Whether or not multi-currency is turned on for this business unit

financial_software_packagestring(Financial Software Package)

Enum"great plains""netsuite""other""peachtree""quickbooks""quickbooks online""sage intacct"

idstring(ID)^\w+$required

The unique, string identifier of this business unit

inventory_costing_methodstring(Inventory Costing Method)required

Enum"do not calculate""fifo""lifo"

inventory_gl_account_idstring(Inventory Gl Account)

The default A/R account

invoice_template_idstring(Invoice Template)

Teh default invoice template to use for printing invoices

is_activeboolean(Is Active)

Whether or not this business unit is active

missing_product_revenue_gl_account_idstring(Missing Product Revenue Gl Account)

The G/L account for missing products

namestring(Name)required

The name of the business unit

overpayment_liability_gl_account_idstring(Overpayment Liability Gl Account)

The default A/R account

payment_receipt_emailobject(Payment Receipt Email)

payment_receipt_template_idstring(Payment Receipt Template)

Teh default payment template to use for printing payment receipts

prioritynumber(float)(Priority)

A priority number that determines how this is displayed; lower numbers indicate higher priority

quickbooks_online_account_idstring(Quickbooks Online Account)

The quickbooks online account tied to the business unit

refund_receipt_emailobject(Refund Receipt Email)

refund_receipt_template_idstring(Refund Receipt Template)

Teh default template to use for printing refund receipts

start_of_fiscal_yearinteger(Start Of Fiscal Year)[ 1 .. 12 ]required

The starting month of the fiscal year, between 1-12

store_credit_gl_account_idstring(Store Credit Gl Account)

The default A/R account

supported_currenciesArray of objectsnon-emptyrequired

supported_currencies[].currency_codestring(Currency Code)= 3 charactersrequired

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

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

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/businessUnits/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accounting_method": "accrual",
    "ar_gl_account_id": "string",
    "automatic_batch_download_options": {
      "accounting_integration_account_id": "string",
      "accounting_integration_service": "integration-qbo-accounts"
    },
    "bad_debts_expense_gl_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_download_method": "batch-level summary",
    "cogs_expense_gl_account_id": "string",
    "currency_trading_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": [
          {}
        ]
      }
    ],
    "default_write_off_method": "allowance",
    "deferred_revenue_gl_account_id": "string",
    "description": "string",
    "download_template_id": "string",
    "due_to_due_from_entries": [
      {
        "accounts_receivable_gl_account_id": "string",
        "business_unit_id": "string",
        "liability_gl_account_id": "string"
      }
    ],
    "enable_automatic_batch_downloads": true,
    "enable_multi_currency": true,
    "financial_software_package": "great plains",
    "id": "string",
    "inventory_costing_method": "do not calculate",
    "inventory_gl_account_id": "string",
    "invoice_template_id": "string",
    "is_active": true,
    "missing_product_revenue_gl_account_id": "string",
    "name": "string",
    "overpayment_liability_gl_account_id": "string",
    "payment_receipt_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "payment_receipt_template_id": "string",
    "priority": 0.1,
    "quickbooks_online_account_id": "string",
    "refund_receipt_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "refund_receipt_template_id": "string",
    "start_of_fiscal_year": 1,
    "store_credit_gl_account_id": "string",
    "supported_currencies": [
      {
        "currency_code": "AED"
      }
    ],
    "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
  }'

Responses

The business unit was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

accounting_methodstring(Accounting Method)

The accounting method for generating subledger entries

Enum"accrual""cash"

ar_gl_account_idstring(Ar Gl Account)

The default A/R account

automatic_batch_download_optionsobject(Automatic Batch Download Options)required

automatic_batch_download_options.accounting_integration_account_idstring(Accounting Integration Account)required

The ID of the accounting integration service

automatic_batch_download_options.accounting_integration_servicestring(Accounting Integration Service)required

Value"integration-qbo-accounts"

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

The default A/R account

base_currency_codestring(Base Currency Code)= 3 charactersrequired

The base currency for the business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the business unit

batch_download_methodstring(Batch Download Method)required

Enum"batch-level summary""detail""summary"

cogs_expense_gl_account_idstring(Cogs Expense Gl Account)

The default COGS expense account

currency_trading_gl_account_idstring(Currency Trading Gl Account)

The default A/R account

custom_field_valuesArray of objects(Custom Field Values)

default_write_off_methodstring(Default Write Off Method)required

Enum"allowance""direct"

deferred_revenue_gl_account_idstring(Deferred Revenue Gl Account)

The default A/R account

descriptionstring(Description)

Any descriptive information about the business unit

download_template_idstring(Download Template)

The optional template to use to format the financial download file

due_to_due_from_entriesArray of objectsnon-empty

enable_automatic_batch_downloadsboolean(Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

enable_multi_currencyboolean(Enable Multi Currency)

Whether or not multi-currency is turned on for this business unit

financial_software_packagestring(Financial Software Package)

Enum"great plains""netsuite""other""peachtree""quickbooks""quickbooks online""sage intacct"

idstring(ID)^\w+$required

The unique, string identifier of this business unit

inventory_costing_methodstring(Inventory Costing Method)required

Enum"do not calculate""fifo""lifo"

inventory_gl_account_idstring(Inventory Gl Account)

The default A/R account

invoice_template_idstring(Invoice Template)

Teh default invoice template to use for printing invoices

is_activeboolean(Is Active)

Whether or not this business unit is active

missing_product_revenue_gl_account_idstring(Missing Product Revenue Gl Account)

The G/L account for missing products

namestring(Name)required

The name of the business unit

overpayment_liability_gl_account_idstring(Overpayment Liability Gl Account)

The default A/R account

payment_receipt_emailobject(Payment Receipt Email)

payment_receipt_template_idstring(Payment Receipt Template)

Teh default payment template to use for printing payment receipts

prioritynumber(float)(Priority)

A priority number that determines how this is displayed; lower numbers indicate higher priority

quickbooks_online_account_idstring(Quickbooks Online Account)

The quickbooks online account tied to the business unit

refund_receipt_emailobject(Refund Receipt Email)

refund_receipt_template_idstring(Refund Receipt Template)

Teh default template to use for printing refund receipts

start_of_fiscal_yearinteger(Start Of Fiscal Year)[ 1 .. 12 ]required

The starting month of the fiscal year, between 1-12

store_credit_gl_account_idstring(Store Credit Gl Account)

The default A/R account

supported_currenciesArray of objectsnon-emptyrequired

supported_currencies[].currency_codestring(Currency Code)= 3 charactersrequired

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

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

Response

application/json

{
  "accounting_method": "accrual",
  "ar_gl_account_id": "string",
  "automatic_batch_download_options": {
    "accounting_integration_account_id": "string",
    "accounting_integration_service": "integration-qbo-accounts"
  },
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_download_method": "batch-level summary",
  "cogs_expense_gl_account_id": "string",
  "currency_trading_gl_account_id": "string",
  "custom_field_values": [
    { … }
  ],
  "default_write_off_method": "allowance",
  "deferred_revenue_gl_account_id": "string",
  "description": "string",
  "download_template_id": "string",
  "due_to_due_from_entries": [
    { … }
  ],
  "enable_automatic_batch_downloads": true,
  "enable_multi_currency": true,
  "financial_software_package": "great plains",
  "id": "string",
  "inventory_costing_method": "do not calculate",
  "inventory_gl_account_id": "string",
  "invoice_template_id": "string",
  "is_active": true,
  "missing_product_revenue_gl_account_id": "string",
  "name": "string",
  "overpayment_liability_gl_account_id": "string",
  "payment_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "payment_receipt_template_id": "string",
  "priority": 0.1,
  "quickbooks_online_account_id": "string",
  "refund_receipt_email": {
    "bcc": "string",
    "body": "string",
    "cc": "string",
    "from": "string",
    "from_name": "string",
    "reply_to": "string",
    "subject": "string"
  },
  "refund_receipt_template_id": "string",
  "start_of_fiscal_year": 1,
  "store_credit_gl_account_id": "string",
  "supported_currencies": [
    { … }
  ],
  "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
}

Check Request Processes

Operations

Check Request Templates

Operations

Check Requests

Operations

Cogs Entries

Operations

Credit Memos

Operations

Credits

Operations

Currency Mapping Policies

Operations

Debit Memos

Operations

Departments

Operations

Donation Products

Operations

Exchange Rates

Operations

External Payments

Operations

Fiscal Years

Operations

Gateway Entities

Operations

Gateway Entries

Operations

Gateway Fees

Operations

Gl Accounts

Operations

Installment Plans

Operations

Installment Schedules

Operations

Invoice Payment Terms

Operations

Invoice Templates

Operations

Invoice Types

Operations

Invoices

Operations

Late Fee Rules

Operations

Late Fees

Operations

Legacy Import Products

Operations

Merchant Accounts

Operations

Miscellaneous Products

Operations

Payment Receipt Templates

Operations

Payments

Operations

Product Financial Configs

Operations

Query Definitions

Operations

Recurring Batches

Operations

Recurring Billing Runs

Operations

Refund Receipt Templates

Operations

Refunds

Operations

Revenue Recognition Schedules

Operations

Settings

Operations

Statement Templates

Operations

Statements

Operations

Statistics

Operations

Stored Payment Methods

Operations

Subledger Entries

Operations

Write Offs

Operations

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

Gets all of the business units in the system.

Request

Responses

Was this helpful?

Creates a new business unit record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a business unit from the system by its ID.

Request

Responses

Was this helpful?

Returns a business unit from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a business unit with the specified ID.

Request

Responses

Was this helpful?

Updates a business unit with the specified ID.

RequestExpand all

Responses

Was this helpful?

Check Request Processes

Check Request Templates

Check Requests

Cogs Entries

Credit Memos

Credits

Currency Mapping Policies

Debit Memos

Departments

Donation Products

Exchange Rates

External Payments

Fiscal Years

Gateway Entities

Gateway Entries

Gateway Fees

Gl Accounts

Installment Plans

Installment Schedules

Invoice Payment Terms

Invoice Templates

Invoice Types

Invoices

Late Fee Rules

Late Fees

Legacy Import Products

Merchant Accounts

Miscellaneous Products

Payment Receipt Templates

Payments

Product Financial Configs

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Refunds

Revenue Recognition Schedules

Settings

Statement Templates

Request

Request

Request