Business Units

Business Units

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

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.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The business unit that you would like to be saved.

id
required
string (ID) /^\w+$/

The unique, string identifier of this business unit

name
required
string (Name)

The name of the business unit

priority
number <float> (Priority)

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

description
string (Description)

Any descriptive information about the business unit

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

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

base_currency_code
required
string (Base Currency Code) 3 characters

The base currency for the business unit

base_currency_symbol
string (Base Currency Symbol)

The base symbol for the business unit

accounting_method
string (Accounting Method)

The accounting method for generating subledger entries

Enum: "cash" "accrual"
enable_multi_currency
boolean (Enable Multi Currency)

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

allowed_currency_codes
required
Array of strings (Allowed Currency Codes) non-empty
Items Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EEK" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GQE" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZM" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEB" "VND" "VUV" "WST" "XAF" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZWR"
exchange_rate_provider
required
string (Exchange Rate Provider)

How the system should calculate exchange rates

Enum: "fixer" "exchange rate table"
required
object (Fixer Credentials)
object (Payment Receipt Email)
object (Refund Receipt Email)
inventory_costing_method
required
string (Inventory Costing Method)
Enum: "do not calculate" "fifo" "lifo"
default_write_off_method
required
string (Default Write Off Method)
Enum: "allowance" "direct"
batch_download_method
required
string (Batch Download Method)
Enum: "batch-level summary" "detail" "summary"
financial_software_package
string (Financial Software Package)
Enum: "quickbooks" "great plains" "peachtree" "quickbooks online" "netsuite" "sage intacct" "other"
download_template_id
string (Download Template)

The optional template to use to format the financial download file

invoice_template_id
string (Invoice Template)

Teh default invoice template to use for printing invoices

payment_receipt_template_id
string (Payment Receipt Template)

Teh default payment template to use for printing payment receipts

refund_receipt_template_id
string (Refund Receipt Template)

Teh default template to use for printing refund receipts

is_active
boolean (Is Active)

Whether or not this business unit is active

ar_gl_account_id
string (Ar Gl Account)

The default A/R account

deferred_revenue_gl_account_id
string (Deferred Revenue Gl Account)

The default A/R account

bad_debts_expense_gl_account_id
string (Bad Debts Expense Gl Account)

The default A/R account

overpayment_liability_gl_account_id
string (Overpayment Liability Gl Account)

The default A/R account

store_credit_gl_account_id
string (Store Credit Gl Account)

The default A/R account

currency_trading_gl_account_id
string (Currency Trading Gl Account)

The default A/R account

inventory_gl_account_id
string (Inventory Gl Account)

The default A/R account

cogs_expense_gl_account_id
string (Cogs Expense Gl Account)

The default COGS expense account

Array of objects non-empty
enable_automatic_batch_downloads
boolean (Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

required
object (Automatic Batch Download Options)
Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

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

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

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

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

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

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (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_version
string (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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The business unit was saved successfully.
400The business unit you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The business unit could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add business unit based on tenant limits.
500General server error.
post/businessUnits/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "description": "string",
  • "start_of_fiscal_year": 1,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "accounting_method": "cash",
  • "enable_multi_currency": true,
  • "allowed_currency_codes": [
    ],
  • "exchange_rate_provider": "fixer",
  • "fixer_credentials": {
    },
  • "payment_receipt_email": {
    },
  • "refund_receipt_email": {
    },
  • "inventory_costing_method": "do not calculate",
  • "default_write_off_method": "allowance",
  • "batch_download_method": "batch-level summary",
  • "financial_software_package": "quickbooks",
  • "download_template_id": "string",
  • "invoice_template_id": "string",
  • "payment_receipt_template_id": "string",
  • "refund_receipt_template_id": "string",
  • "is_active": true,
  • "ar_gl_account_id": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "bad_debts_expense_gl_account_id": "string",
  • "overpayment_liability_gl_account_id": "string",
  • "store_credit_gl_account_id": "string",
  • "currency_trading_gl_account_id": "string",
  • "inventory_gl_account_id": "string",
  • "cogs_expense_gl_account_id": "string",
  • "due_to_due_from_entries": [
    ],
  • "enable_automatic_batch_downloads": true,
  • "automatic_batch_download_options": {
    },
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "description": "string",
  • "start_of_fiscal_year": 1,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "accounting_method": "cash",
  • "enable_multi_currency": true,
  • "allowed_currency_codes": [
    ],
  • "exchange_rate_provider": "fixer",
  • "fixer_credentials": {
    },
  • "payment_receipt_email": {
    },
  • "refund_receipt_email": {
    },
  • "inventory_costing_method": "do not calculate",
  • "default_write_off_method": "allowance",
  • "batch_download_method": "batch-level summary",
  • "financial_software_package": "quickbooks",
  • "download_template_id": "string",
  • "invoice_template_id": "string",
  • "payment_receipt_template_id": "string",
  • "refund_receipt_template_id": "string",
  • "is_active": true,
  • "ar_gl_account_id": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "bad_debts_expense_gl_account_id": "string",
  • "overpayment_liability_gl_account_id": "string",
  • "store_credit_gl_account_id": "string",
  • "currency_trading_gl_account_id": "string",
  • "inventory_gl_account_id": "string",
  • "cogs_expense_gl_account_id": "string",
  • "due_to_due_from_entries": [
    ],
  • "enable_automatic_batch_downloads": true,
  • "automatic_batch_download_options": {
    },
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Gets all of the business units in the system.

This method will scan all business units and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

exclusiveStartKey
string

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

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

Returns a business unit from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the business unit to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The business unit was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The business unit could not be found.
429Limit exceeded... unable to retrieve business unit based on tenant limits.
500General server error.
get/businessUnits/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/businessUnits/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "description": "string",
  • "start_of_fiscal_year": 1,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "accounting_method": "cash",
  • "enable_multi_currency": true,
  • "allowed_currency_codes": [
    ],
  • "exchange_rate_provider": "fixer",
  • "fixer_credentials": {
    },
  • "payment_receipt_email": {
    },
  • "refund_receipt_email": {
    },
  • "inventory_costing_method": "do not calculate",
  • "default_write_off_method": "allowance",
  • "batch_download_method": "batch-level summary",
  • "financial_software_package": "quickbooks",
  • "download_template_id": "string",
  • "invoice_template_id": "string",
  • "payment_receipt_template_id": "string",
  • "refund_receipt_template_id": "string",
  • "is_active": true,
  • "ar_gl_account_id": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "bad_debts_expense_gl_account_id": "string",
  • "overpayment_liability_gl_account_id": "string",
  • "store_credit_gl_account_id": "string",
  • "currency_trading_gl_account_id": "string",
  • "inventory_gl_account_id": "string",
  • "cogs_expense_gl_account_id": "string",
  • "due_to_due_from_entries": [
    ],
  • "enable_automatic_batch_downloads": true,
  • "automatic_batch_download_options": {
    },
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a business unit with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the business unit to update.

Request Body schema: application/json

The updated business unit that will be saved.

id
required
string (ID) /^\w+$/

The unique, string identifier of this business unit

name
required
string (Name)

The name of the business unit

priority
number <float> (Priority)

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

description
string (Description)

Any descriptive information about the business unit

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

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

base_currency_code
required
string (Base Currency Code) 3 characters

The base currency for the business unit

base_currency_symbol
string (Base Currency Symbol)

The base symbol for the business unit

accounting_method
string (Accounting Method)

The accounting method for generating subledger entries

Enum: "cash" "accrual"
enable_multi_currency
boolean (Enable Multi Currency)

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

allowed_currency_codes
required
Array of strings (Allowed Currency Codes) non-empty
Items Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTN" "BWP" "BYR" "BZD" "CAD" "CDF" "CHF" "CLP" "CNY" "COP" "CRC" "CUC" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EEK" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GQE" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LTL" "LVL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MUR" "MVR" "MWK" "MXN" "MYR" "MZM" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "UYU" "UZS" "VEB" "VND" "VUV" "WST" "XAF" "XCD" "XDR" "XOF" "XPF" "YER" "ZAR" "ZMK" "ZWR"
exchange_rate_provider
required
string (Exchange Rate Provider)

How the system should calculate exchange rates

Enum: "fixer" "exchange rate table"
required
object (Fixer Credentials)
object (Payment Receipt Email)
object (Refund Receipt Email)
inventory_costing_method
required
string (Inventory Costing Method)
Enum: "do not calculate" "fifo" "lifo"
default_write_off_method
required
string (Default Write Off Method)
Enum: "allowance" "direct"
batch_download_method
required
string (Batch Download Method)
Enum: "batch-level summary" "detail" "summary"
financial_software_package
string (Financial Software Package)
Enum: "quickbooks" "great plains" "peachtree" "quickbooks online" "netsuite" "sage intacct" "other"
download_template_id
string (Download Template)

The optional template to use to format the financial download file

invoice_template_id
string (Invoice Template)

Teh default invoice template to use for printing invoices

payment_receipt_template_id
string (Payment Receipt Template)

Teh default payment template to use for printing payment receipts

refund_receipt_template_id
string (Refund Receipt Template)

Teh default template to use for printing refund receipts

is_active
boolean (Is Active)

Whether or not this business unit is active

ar_gl_account_id
string (Ar Gl Account)

The default A/R account

deferred_revenue_gl_account_id
string (Deferred Revenue Gl Account)

The default A/R account

bad_debts_expense_gl_account_id
string (Bad Debts Expense Gl Account)

The default A/R account

overpayment_liability_gl_account_id
string (Overpayment Liability Gl Account)

The default A/R account

store_credit_gl_account_id
string (Store Credit Gl Account)

The default A/R account

currency_trading_gl_account_id
string (Currency Trading Gl Account)

The default A/R account

inventory_gl_account_id
string (Inventory Gl Account)

The default A/R account

cogs_expense_gl_account_id
string (Cogs Expense Gl Account)

The default COGS expense account

Array of objects non-empty
enable_automatic_batch_downloads
boolean (Enable Automatic Batch Downloads)

When enabled, batches are automatically synced with users accounting software

required
object (Automatic Batch Download Options)
Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

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

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

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

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

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

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (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_version
string (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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The business unit was updated successfully.
400The business unit supplied was not valid.
401Unauthorized.
403Forbidden.
404The business unit could not be found.
409The business unit could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve business unit based on tenant limits.
500General server error.
put/businessUnits/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "description": "string",
  • "start_of_fiscal_year": 1,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "accounting_method": "cash",
  • "enable_multi_currency": true,
  • "allowed_currency_codes": [
    ],
  • "exchange_rate_provider": "fixer",
  • "fixer_credentials": {
    },
  • "payment_receipt_email": {
    },
  • "refund_receipt_email": {
    },
  • "inventory_costing_method": "do not calculate",
  • "default_write_off_method": "allowance",
  • "batch_download_method": "batch-level summary",
  • "financial_software_package": "quickbooks",
  • "download_template_id": "string",
  • "invoice_template_id": "string",
  • "payment_receipt_template_id": "string",
  • "refund_receipt_template_id": "string",
  • "is_active": true,
  • "ar_gl_account_id": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "bad_debts_expense_gl_account_id": "string",
  • "overpayment_liability_gl_account_id": "string",
  • "store_credit_gl_account_id": "string",
  • "currency_trading_gl_account_id": "string",
  • "inventory_gl_account_id": "string",
  • "cogs_expense_gl_account_id": "string",
  • "due_to_due_from_entries": [
    ],
  • "enable_automatic_batch_downloads": true,
  • "automatic_batch_download_options": {
    },
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "description": "string",
  • "start_of_fiscal_year": 1,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "accounting_method": "cash",
  • "enable_multi_currency": true,
  • "allowed_currency_codes": [
    ],
  • "exchange_rate_provider": "fixer",
  • "fixer_credentials": {
    },
  • "payment_receipt_email": {
    },
  • "refund_receipt_email": {
    },
  • "inventory_costing_method": "do not calculate",
  • "default_write_off_method": "allowance",
  • "batch_download_method": "batch-level summary",
  • "financial_software_package": "quickbooks",
  • "download_template_id": "string",
  • "invoice_template_id": "string",
  • "payment_receipt_template_id": "string",
  • "refund_receipt_template_id": "string",
  • "is_active": true,
  • "ar_gl_account_id": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "bad_debts_expense_gl_account_id": "string",
  • "overpayment_liability_gl_account_id": "string",
  • "store_credit_gl_account_id": "string",
  • "currency_trading_gl_account_id": "string",
  • "inventory_gl_account_id": "string",
  • "cogs_expense_gl_account_id": "string",
  • "due_to_due_from_entries": [
    ],
  • "enable_automatic_batch_downloads": true,
  • "automatic_batch_download_options": {
    },
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a business unit with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the business unit to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

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

The JSON path

value
string (Value)
Responses
200The business unit was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The business unit could not be found.
409The business unit could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve business unit based on tenant limits.
500General server error.
patch/businessUnits/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "priority": 0,
  • "description": "string",
  • "start_of_fiscal_year": 1,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "accounting_method": "cash",
  • "enable_multi_currency": true,
  • "allowed_currency_codes": [
    ],
  • "exchange_rate_provider": "fixer",
  • "fixer_credentials": {
    },
  • "payment_receipt_email": {
    },
  • "refund_receipt_email": {
    },
  • "inventory_costing_method": "do not calculate",
  • "default_write_off_method": "allowance",
  • "batch_download_method": "batch-level summary",
  • "financial_software_package": "quickbooks",
  • "download_template_id": "string",
  • "invoice_template_id": "string",
  • "payment_receipt_template_id": "string",
  • "refund_receipt_template_id": "string",
  • "is_active": true,
  • "ar_gl_account_id": "string",
  • "deferred_revenue_gl_account_id": "string",
  • "bad_debts_expense_gl_account_id": "string",
  • "overpayment_liability_gl_account_id": "string",
  • "store_credit_gl_account_id": "string",
  • "currency_trading_gl_account_id": "string",
  • "inventory_gl_account_id": "string",
  • "cogs_expense_gl_account_id": "string",
  • "due_to_due_from_entries": [
    ],
  • "enable_automatic_batch_downloads": true,
  • "automatic_batch_download_options": {
    },
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a business unit from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the business unit to delete.

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

Execute Batch Operations

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The business unit could not be found.
429Limit exceeded... unable to retrieve business unit based on tenant limits.
500General server error.
post/businessUnits/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}