Subledger Entries

Subledger Entries

Creates a new subledger entry record that does not already exist.

This method will auto-generate an ID and create a new subledger entry. If an ID is specified for the subledger entry, 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 subledger entry that you would like to be saved.

id
required
string (ID)

A unique id for the entry

business_unit_id
required
string (Business Unit)

The business unit that the batch belongs in

fiscal_year_id
required
string (Fiscal Year)

The fiscal year of the business unit

fiscal_period
required
integer (Fiscal Period) [ 1 .. 12 ]

The fiscal period of the batch

date
required
string <date> (Date)

The date of the batch

batch_id
required
string (Batch)

The batch the entry is tied to

cogs_entry_id
string (Cogs Entry)
invoice_id
string (Invoice)
payment_id
string (Payment)
credit_id
string (Credit)
revenue_recognition_schedule_id
string (Revenue Recognition Schedule)
revenue_recognition_schedule_entry_id
string (Revenue Recognition Schedule Entry)
refund_id
string (Refund)
write_off_id
string (Write Off)
gift_id
string (Gift)
inventory_receipt_id
string (Inventory Receipt)
credit_memo_id
string (Credit Memo)
debit_memo_id
string (Debit Memo)
credit_usage_id
string (Credit Usage)
contact_id
string (Contact)
organization_id
string (Organization)
transaction_type
string (Transaction Type)
transaction_id
string (Transaction)
customer_type
string (Customer Type)
Enum: "contact" "organization"
required
Array of objects >= 2 items
credit_card_last_five_digits
string (Credit Card Last Five Digits)

For payments, the last five digits of the credit card

payment_reference_number
string (Payment Reference Number)

For payments, the reference or check #

payment_type
string (Payment Type)

The payment type

payment_card_type
string (Payment Card Type)

The tyep of card for payment

notes
string (Notes)
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 subledger entry was saved successfully.
400The subledger entry you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The subledger entry could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add subledger entry based on tenant limits.
500General server error.
post/subledgerEntries/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "date": "2019-08-24",
  • "batch_id": "string",
  • "cogs_entry_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "credit_id": "string",
  • "revenue_recognition_schedule_id": "string",
  • "revenue_recognition_schedule_entry_id": "string",
  • "refund_id": "string",
  • "write_off_id": "string",
  • "gift_id": "string",
  • "inventory_receipt_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "credit_usage_id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "transaction_type": "string",
  • "transaction_id": "string",
  • "customer_type": "contact",
  • "items": [
    ],
  • "credit_card_last_five_digits": "string",
  • "payment_reference_number": "string",
  • "payment_type": "string",
  • "payment_card_type": "string",
  • "notes": "string",
  • "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",
  • "business_unit_id": "string",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "date": "2019-08-24",
  • "batch_id": "string",
  • "cogs_entry_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "credit_id": "string",
  • "revenue_recognition_schedule_id": "string",
  • "revenue_recognition_schedule_entry_id": "string",
  • "refund_id": "string",
  • "write_off_id": "string",
  • "gift_id": "string",
  • "inventory_receipt_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "credit_usage_id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "transaction_type": "string",
  • "transaction_id": "string",
  • "customer_type": "contact",
  • "items": [
    ],
  • "credit_card_last_five_digits": "string",
  • "payment_reference_number": "string",
  • "payment_type": "string",
  • "payment_card_type": "string",
  • "notes": "string",
  • "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 subledger entry from the system by its ID.

This method will look up a subledger entry 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 subledger entry 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 subledger entry was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The subledger entry could not be found.
429Limit exceeded... unable to retrieve subledger entry based on tenant limits.
500General server error.
get/subledgerEntries/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "date": "2019-08-24",
  • "batch_id": "string",
  • "cogs_entry_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "credit_id": "string",
  • "revenue_recognition_schedule_id": "string",
  • "revenue_recognition_schedule_entry_id": "string",
  • "refund_id": "string",
  • "write_off_id": "string",
  • "gift_id": "string",
  • "inventory_receipt_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "credit_usage_id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "transaction_type": "string",
  • "transaction_id": "string",
  • "customer_type": "contact",
  • "items": [
    ],
  • "credit_card_last_five_digits": "string",
  • "payment_reference_number": "string",
  • "payment_type": "string",
  • "payment_card_type": "string",
  • "notes": "string",
  • "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 subledger entry with the specified ID.

This method will update an existing subledger entry 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 subledger entry to update.

Request Body schema: application/json

The updated subledger entry that will be saved.

id
required
string (ID)

A unique id for the entry

business_unit_id
required
string (Business Unit)

The business unit that the batch belongs in

fiscal_year_id
required
string (Fiscal Year)

The fiscal year of the business unit

fiscal_period
required
integer (Fiscal Period) [ 1 .. 12 ]

The fiscal period of the batch

date
required
string <date> (Date)

The date of the batch

batch_id
required
string (Batch)

The batch the entry is tied to

cogs_entry_id
string (Cogs Entry)
invoice_id
string (Invoice)
payment_id
string (Payment)
credit_id
string (Credit)
revenue_recognition_schedule_id
string (Revenue Recognition Schedule)
revenue_recognition_schedule_entry_id
string (Revenue Recognition Schedule Entry)
refund_id
string (Refund)
write_off_id
string (Write Off)
gift_id
string (Gift)
inventory_receipt_id
string (Inventory Receipt)
credit_memo_id
string (Credit Memo)
debit_memo_id
string (Debit Memo)
credit_usage_id
string (Credit Usage)
contact_id
string (Contact)
organization_id
string (Organization)
transaction_type
string (Transaction Type)
transaction_id
string (Transaction)
customer_type
string (Customer Type)
Enum: "contact" "organization"
required
Array of objects >= 2 items
credit_card_last_five_digits
string (Credit Card Last Five Digits)

For payments, the last five digits of the credit card

payment_reference_number
string (Payment Reference Number)

For payments, the reference or check #

payment_type
string (Payment Type)

The payment type

payment_card_type
string (Payment Card Type)

The tyep of card for payment

notes
string (Notes)
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 subledger entry was updated successfully.
400The subledger entry supplied was not valid.
401Unauthorized.
403Forbidden.
404The subledger entry could not be found.
409The subledger entry could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve subledger entry based on tenant limits.
500General server error.
put/subledgerEntries/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "date": "2019-08-24",
  • "batch_id": "string",
  • "cogs_entry_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "credit_id": "string",
  • "revenue_recognition_schedule_id": "string",
  • "revenue_recognition_schedule_entry_id": "string",
  • "refund_id": "string",
  • "write_off_id": "string",
  • "gift_id": "string",
  • "inventory_receipt_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "credit_usage_id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "transaction_type": "string",
  • "transaction_id": "string",
  • "customer_type": "contact",
  • "items": [
    ],
  • "credit_card_last_five_digits": "string",
  • "payment_reference_number": "string",
  • "payment_type": "string",
  • "payment_card_type": "string",
  • "notes": "string",
  • "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",
  • "business_unit_id": "string",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "date": "2019-08-24",
  • "batch_id": "string",
  • "cogs_entry_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "credit_id": "string",
  • "revenue_recognition_schedule_id": "string",
  • "revenue_recognition_schedule_entry_id": "string",
  • "refund_id": "string",
  • "write_off_id": "string",
  • "gift_id": "string",
  • "inventory_receipt_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "credit_usage_id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "transaction_type": "string",
  • "transaction_id": "string",
  • "customer_type": "contact",
  • "items": [
    ],
  • "credit_card_last_five_digits": "string",
  • "payment_reference_number": "string",
  • "payment_type": "string",
  • "payment_card_type": "string",
  • "notes": "string",
  • "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 subledger entry with the specified ID.

This method will patch an existing subledger entry 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 subledger entry 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 subledger entry was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The subledger entry could not be found.
409The subledger entry could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve subledger entry based on tenant limits.
500General server error.
patch/subledgerEntries/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "date": "2019-08-24",
  • "batch_id": "string",
  • "cogs_entry_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "credit_id": "string",
  • "revenue_recognition_schedule_id": "string",
  • "revenue_recognition_schedule_entry_id": "string",
  • "refund_id": "string",
  • "write_off_id": "string",
  • "gift_id": "string",
  • "inventory_receipt_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "credit_usage_id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "transaction_type": "string",
  • "transaction_id": "string",
  • "customer_type": "contact",
  • "items": [
    ],
  • "credit_card_last_five_digits": "string",
  • "payment_reference_number": "string",
  • "payment_type": "string",
  • "payment_card_type": "string",
  • "notes": "string",
  • "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 subledger entry from the system by its ID.

This method will delete a subledger entry 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 subledger entry to delete.

Responses
200The subledger entry was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The subledger entry could not be found.
409The subledger entry could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete subledger entry based on tenant limits.
500General server error.
delete/subledgerEntries/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/: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 subledger entry could not be found.
429Limit exceeded... unable to retrieve subledger entry based on tenant limits.
500General server error.
post/subledgerEntries/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}

Returns a list of records with the specified batch_id

Returns a list of records with the specified batch_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

batch_id
required
string

The batch_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/batch/{batch_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/batch/:batch_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified invoice_id

Returns a list of records with the specified invoice_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

invoice_id
required
string

The invoice_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/invoice/{invoice_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/invoice/:invoice_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified payment_id

Returns a list of records with the specified payment_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

payment_id
required
string

The payment_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/payment/{payment_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/payment/:payment_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified credit_id

Returns a list of records with the specified credit_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

credit_id
required
string

The credit_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/credit/{credit_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/credit/:credit_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified credit_memo_id

Returns a list of records with the specified credit_memo_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

credit_memo_id
required
string

The credit_memo_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/creditMemo/{credit_memo_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/creditMemo/:credit_memo_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified debit_memo_id

Returns a list of records with the specified debit_memo_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

debit_memo_id
required
string

The debit_memo_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/debitMemo/{debit_memo_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/debitMemo/:debit_memo_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified cogs_entry_id

Returns a list of records with the specified cogs_entry_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

cogs_entry_id
required
string

The cogs_entry_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/cogsEntry/{cogs_entry_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/cogsEntry/:cogs_entry_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified revenue_recognition_schedule_id

Returns a list of records with the specified revenue_recognition_schedule_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

revenue_recognition_schedule_id
required
string

The revenue_recognition_schedule_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/revenueRecognitionSchedule/{revenue_recognition_schedule_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/revenueRecognitionSchedule/:revenue_recognition_schedule_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified write_off_id

Returns a list of records with the specified write_off_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

write_off_id
required
string

The write_off_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/writeOff/{write_off_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/writeOff/:write_off_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified inventory_receipt_id

Returns a list of records with the specified inventory_receipt_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

inventory_receipt_id
required
string

The inventory_receipt_id to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/inventoryReceipt/{inventory_receipt_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/inventoryReceipt/:inventory_receipt_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified fiscal_period

Returns a list of records with the specified fiscal_period

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

business_unit_id
required
string

The business_unit_id to use to for record lookup

fiscal_year_id
required
string

The fiscal_year_id to use to for record lookup

fiscal_period
required
string

The fiscal_period to use to for record lookup

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/subledgerEntries/{tenantId}/fiscalPeriod/{business_unit_id}/{fiscal_year_id}/{fiscal_period}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/subledgerEntries/:tenantId/fiscalPeriod/:business_unit_id/:fiscal_year_id/:fiscal_period?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}