Write Offs

Accounting Projects

Operations

Bank Accounts

Operations

Batch Assignment Settings

Operations

Batch Downloading

Operations

Batch Posting

Operations

Batch Templates

Operations

Batches

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Business Units

Operations

Check Request Processes

Operations

Check Request Templates

Operations

Check Requests

Operations

Cogs Entries

Operations

Credit Memos

Operations

Credits

Operations

Currency Mapping Policies

Operations

Debit Memos

Operations

Departments

Operations

Donation Products

Operations

Exchange Rates

Operations

External Payments

Operations

Fiscal Years

Operations

Gateway Entities

Operations

Gateway Entries

Operations

Gateway Fees

Operations

Gl Accounts

Operations

Installment Plans

Operations

Installment Schedules

Operations

Invoice Payment Terms

Operations

Invoice Templates

Operations

Invoice Types

Operations

Invoices

Operations

Late Fee Rules

Operations

Late Fees

Operations

Legacy Import Products

Operations

Merchant Accounts

Operations

Miscellaneous Products

Operations

Payment Receipt Templates

Operations

Payments

Operations

Product Financial Configs

Operations

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

Initiates workflow to warm up inventory transactions

Request

Security

knox-authorizer

curl -i -X POST \
  https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/warmUpStepFunctions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Gets all of the write offs in the system.

Request

This method will scan all write offs and and return them to the caller.

Security

knox-authorizer

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

Responses

The write offswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

]

Response

application/json

[
  {
    "bad_debts_expense_gl_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "currency_code": "AED",
    "currency_symbol": "string",
    "custom_field_values": [ … ],
    "date": "2019-08-24",
    "exchange_rate": 0.1,
    "id": "string",
    "invoice_id": "string",
    "line_items": [ … ],
    "memo": "string",
    "method": "allowance",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "return_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_search_composite_key": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": 0.1,
    "total_in_base_currency": 0.1,
    "workflow_execution_id": "string"
  }
]

Processes a new write off

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The write off that you would like to be saved.

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bad_debts_expense_gl_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "currency_code": "AED",
    "currency_symbol": "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": [
          {}
        ]
      }
    ],
    "date": "2019-08-24",
    "exchange_rate": 0.1,
    "id": "string",
    "invoice_id": "string",
    "line_items": [
      {
        "description": "string",
        "invoice_line_item_id": "string",
        "product_id": "string",
        "product_type": "string",
        "total": 0.1,
        "total_in_base_currency": null
      }
    ],
    "memo": "string",
    "method": "allowance",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "return_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_search_composite_key": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": 0.1,
    "total_in_base_currency": 0.1,
    "workflow_execution_id": "string"
  }'

Responses

The write off was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

executionArnstring(Executionarn)required

The arn of the execution

notification_channelstring(Notification Channel)

The id of the channel where progress updates will be posted

notification_publishKeystring(Notification Publishkey)

The publish key for the channel where progress updates will be posted

notification_subscribeKeystring(Notification Subscribekey)

The subscribe key for the channel where progress updates will be posted

start_datestring(date-time)(Start Date)

The start date of the execution

Response

application/json

{
  "executionArn": "string",
  "notification_channel": "string",
  "notification_publishKey": "string",
  "notification_subscribeKey": "string",
  "start_date": "2019-08-24T14:15:22Z"
}

Execute Batch Operations

Request

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

Security

knox-authorizer

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/writeOffs/{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 list of records with the specified batch_id

Request

Returns a list of records with the specified batch_id

Security

knox-authorizer

Path

tenantIdstringrequired

The tenant

batch_idstringrequired

The batch_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

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

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

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(WriteOff)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Searches for write offs using predefined parameters

Request

Searches for write offs using predefined parameters

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The write off that you would like to be saved.

batch_idArray of strings(Batch)

business_unit_idstring(Business Unit)required

The business unit

dateArray of strings(Date)= 2 items

idArray of strings(ID)

numberArray of numbers(float)(Number)= 2 items

totalArray of numbers(float)(Total)= 2 items

total_in_base_currencyArray of numbers(float)(Total In Base Currency)= 2 items

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batch_id": [
      "string"
    ],
    "business_unit_id": "string",
    "date": [
      "string",
      "string"
    ],
    "id": [
      "string"
    ],
    "number": [
      0.1,
      0.1
    ],
    "total": [
      0.1,
      0.1
    ],
    "total_in_base_currency": [
      0.1,
      0.1
    ]
  }'

Responses

The write off search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(WriteOffSearchResults)

LastEvaluatedKeystring

Response

application/json

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Creates a new credit that doesn't already exist

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The write off that you would like to be saved.

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bad_debts_expense_gl_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "currency_code": "AED",
    "currency_symbol": "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": [
          {}
        ]
      }
    ],
    "date": "2019-08-24",
    "exchange_rate": 0.1,
    "id": "string",
    "invoice_id": "string",
    "line_items": [
      {
        "description": "string",
        "invoice_line_item_id": "string",
        "product_id": "string",
        "product_type": "string",
        "total": 0.1,
        "total_in_base_currency": null
      }
    ],
    "memo": "string",
    "method": "allowance",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "return_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_search_composite_key": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": 0.1,
    "total_in_base_currency": 0.1,
    "workflow_execution_id": "string"
  }'

Responses

The write off was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response

application/json

{
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "exchange_rate": 0.1,
  "id": "string",
  "invoice_id": "string",
  "line_items": [
    { … }
  ],
  "memo": "string",
  "method": "allowance",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "return_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_search_composite_key": "string",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": 0.1,
  "total_in_base_currency": 0.1,
  "workflow_execution_id": "string"
}

Returns a write off from the system by its ID.

Request

This method will look up a write off by the specified ID and return it back.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The write off was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response

application/json

{
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "exchange_rate": 0.1,
  "id": "string",
  "invoice_id": "string",
  "line_items": [
    { … }
  ],
  "memo": "string",
  "method": "allowance",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "return_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_search_composite_key": "string",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": 0.1,
  "total_in_base_currency": 0.1,
  "workflow_execution_id": "string"
}

Partially updates a write off with the specified ID.

Request

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

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

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

Responses

The write off was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response

application/json

{
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "exchange_rate": 0.1,
  "id": "string",
  "invoice_id": "string",
  "line_items": [
    { … }
  ],
  "memo": "string",
  "method": "allowance",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "return_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_search_composite_key": "string",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": 0.1,
  "total_in_base_currency": 0.1,
  "workflow_execution_id": "string"
}

Updates a write off with the specified ID.

Request

This method will update an existing write off with the specified ID.

Security

knox-authorizer

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the write off to update.

Bodyapplication/jsonrequired

The updated write off that will be saved.

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/collect/collect-v1/writeOffs/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "bad_debts_expense_gl_account_id": "string",
    "base_currency_code": "str",
    "base_currency_symbol": "string",
    "batch_id": "string",
    "business_unit_id": "string",
    "cancellation_id": "string",
    "currency_code": "AED",
    "currency_symbol": "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": [
          {}
        ]
      }
    ],
    "date": "2019-08-24",
    "exchange_rate": 0.1,
    "id": "string",
    "invoice_id": "string",
    "line_items": [
      {
        "description": "string",
        "invoice_line_item_id": "string",
        "product_id": "string",
        "product_type": "string",
        "total": 0.1,
        "total_in_base_currency": null
      }
    ],
    "memo": "string",
    "method": "allowance",
    "notes": "string",
    "number": 0,
    "order_id": "string",
    "return_id": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_search_composite_key": "string",
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": 0.1,
    "total_in_base_currency": 0.1,
    "workflow_execution_id": "string"
  }'

Responses

The write off was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

bad_debts_expense_gl_account_idstring(Bad Debts Expense Gl Account)

Bad debts expense GL account, required for allowance method

base_currency_codestring(Base Currency Code)= 3 characters

The base currency for transactions business unit

base_currency_symbolstring(Base Currency Symbol)

The base symbol for the transactions business unit

batch_idstring(Batch)required

The batch this transaction belongs to

business_unit_idstring(Business Unit)required

The business unit this transaction belongs to

cancellation_idstring(Cancellation)

The order cancellation tied to this transaction

currency_codestring(Currency Code)= 3 characters

The currency code in use

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

currency_symbolstring(Currency Symbol)

The currency symbol

custom_field_valuesArray of objects(Custom Field Values)

datestring(date)(Date)

The date of the transaction

exchange_ratenumber(double)(Exchange Rate)

The exchange rate, if applicable

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

The unique, string identifier of this write off

invoice_idstring(Invoice)required

The invoice the write off applies to

line_itemsArray of objectsnon-emptyrequired

One of:

line_items[].total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

line_items[].descriptionstring(Description)

Descriptive information

line_items[].invoice_line_item_idstring(Invoice Line Item)required

The invoice line item being modified

line_items[].product_idstring(Product)required

The id of the product

line_items[].product_typestring(Product Type)required

The type of product

line_items[].totalnumber(double)(Total)required

Total of the line item

memostring(Memo)

Memo/description of the transaction

methodstring(Method)required

The mechanism for completing the write off

Enum"allowance""direct"

notesstring(Notes)

Notes fro the transaction

numberinteger(Number)required

The transaction number

order_idstring(Order)

The order tied to this transaction

return_idstring(Return)

The return tied to this transaction

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_search_composite_keystring(Sys Search Composite Key)

Internal use

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

totalnumber(double)(Total)required

The transaction total

total_in_base_currencynumber(double)(Total In Base Currency)required

The total of the transaction, in the base currency of the business unit.

workflow_execution_idstring(Workflow Execution)

The ID of the state machine execution used to create this transaction

Response

application/json

{
  "bad_debts_expense_gl_account_id": "string",
  "base_currency_code": "str",
  "base_currency_symbol": "string",
  "batch_id": "string",
  "business_unit_id": "string",
  "cancellation_id": "string",
  "currency_code": "AED",
  "currency_symbol": "string",
  "custom_field_values": [
    { … }
  ],
  "date": "2019-08-24",
  "exchange_rate": 0.1,
  "id": "string",
  "invoice_id": "string",
  "line_items": [
    { … }
  ],
  "memo": "string",
  "method": "allowance",
  "notes": "string",
  "number": 0,
  "order_id": "string",
  "return_id": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_search_composite_key": "string",
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": 0.1,
  "total_in_base_currency": 0.1,
  "workflow_execution_id": "string"
}

Accounting Projects

Bank Accounts

Batch Assignment Settings

Batch Downloading

Batch Posting

Batch Templates

Batches

Billing Notices

Billing Run Actions

Billing Runs

Billing Templates

Business Units

Check Request Processes

Check Request Templates

Check Requests

Cogs Entries

Credit Memos

Credits

Currency Mapping Policies

Debit Memos

Departments

Donation Products

Exchange Rates

External Payments

Fiscal Years

Gateway Entities

Gateway Entries

Gateway Fees

Gl Accounts

Installment Plans

Installment Schedules

Invoice Payment Terms

Invoice Templates

Invoice Types

Invoices

Late Fee Rules

Late Fees

Legacy Import Products

Merchant Accounts

Miscellaneous Products

Payment Receipt Templates

Payments

Product Financial Configs

Query Definitions

Recurring Batches

Recurring Billing Runs

Refund Receipt Templates

Refunds

Revenue Recognition Schedules

Settings

Statement Templates

Statements

Statistics

Stored Payment Methods

Subledger Entries

Write Offs

Initiates workflow to warm up inventory transactions

Request

Responses

Was this helpful?

Gets all of the write offs in the system.

Request

Responses

Was this helpful?

Processes a new write off

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified batch_id

Request

Responses

Was this helpful?

Searches for write offs using predefined parameters

Request

Responses

Was this helpful?

Request

Request

Request

Request