Debit Memos

Debit Memos

Returns a debit memo from the system by its ID.

This method will look up a debit memo 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 debit memo 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 debit memo was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The debit memo could not be found.
429Limit exceeded... unable to retrieve debit memo based on tenant limits.
500General server error.
get/debitMemos/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/debitMemos/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "invoice_id": "string",
  • "line_items": [
    ],
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "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 debit memo with the specified ID.

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

Request Body schema: application/json

The updated debit memo that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this debit memo

invoice_id
required
string (Invoice)

The invoice the debit memo applies to

required
Array of objects non-empty
Array of objects (Custom Field Values)
number
required
integer (Number)

The transaction number

workflow_execution_id
string (Workflow Execution)

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

total
required
number <double> (Total)

The transaction total

business_unit_id
required
string (Business Unit)

The business unit this transaction belongs to

batch_id
required
string (Batch)

The batch this transaction belongs to

cancellation_id
string (Cancellation)

The order cancellation tied to this transaction

order_id
string (Order)

The order tied to this transaction

return_id
string (Return)

The return tied to this transaction

memo
string (Memo)

Memo/description of the transaction

notes
string (Notes)

Notes fro the transaction

date
string <date> (Date)

The date of the transaction

currency_code
string (Currency Code) 3 characters

The currency code in use

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

The currency symbol

exchange_rate
number <double> (Exchange Rate)

The exchange rate, if applicable

total_in_base_currency
required
number <double> (Total In Base Currency)

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

base_currency_code
string (Base Currency Code) 3 characters

The base currency for transactions business unit

base_currency_symbol
string (Base Currency Symbol)

The base symbol for the transactions business unit

sys_search_composite_key
string (Sys Search Composite Key)

Internal use

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 debit memo was updated successfully.
400The debit memo supplied was not valid.
401Unauthorized.
403Forbidden.
404The debit memo could not be found.
409The debit memo could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve debit memo based on tenant limits.
500General server error.
put/debitMemos/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "invoice_id": "string",
  • "line_items": [
    ],
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "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",
  • "invoice_id": "string",
  • "line_items": [
    ],
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "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 debit memo with the specified ID.

This method will patch an existing debit memo 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 debit memo 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 debit memo was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The debit memo could not be found.
409The debit memo could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve debit memo based on tenant limits.
500General server error.
patch/debitMemos/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "invoice_id": "string",
  • "line_items": [
    ],
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "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": [
    ]
}

Searches for debit memos using predefined parameters

Searches for debit memos using predefined parameters

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

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

Request Body schema: application/json

The debit memo that you would like to be saved.

business_unit_id
required
string (Business Unit)

The business unit

batch_id
Array of strings (Batch)
date
Array of strings (Date) 2 items
number
Array of numbers <float> (Number) 2 items
total
Array of numbers <float> (Total) 2 items
id
Array of strings (ID)
total_in_base_currency
Array of numbers <float> (Total In Base Currency) 2 items
Responses
200The debit memo search was saved successfully.
400The debit memo you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The debit memo could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add debit memo based on tenant limits.
500General server error.
post/debitMemos/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "business_unit_id": "string",
  • "batch_id": [
    ],
  • "date": [
    ],
  • "number": [
    ],
  • "total": [
    ],
  • "id": [
    ],
  • "total_in_base_currency": [
    ]
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

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/debitMemos/{tenantId}/batch/{batch_id}
Request samples
curl -i -X GET \
  'https://collect.api.756794052567.rhythmsoftware.com/debitMemos/:tenantId/batch/:batch_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Initiates workflow to warm up inventory transactions

Request
Security:
knox-authorizer
Responses
200Success
400The request was not valid
401Unauthorized
403Forbidden
404The resource could not be found
429Request limit exceeded... please try your request again in a few seconds
500An internal server error occured.
post/debitMemos/warmUpStepFunctions
Request samples
curl -i -X POST \
  https://collect.api.756794052567.rhythmsoftware.com/debitMemos/warmUpStepFunctions \
  -H 'Authorization: YOUR_API_KEY_HERE'

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 debit memo could not be found.
429Limit exceeded... unable to retrieve debit memo based on tenant limits.
500General server error.
post/debitMemos/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}

Processes a new debit memo

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

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this debit memo

invoice_id
required
string (Invoice)

The invoice the debit memo applies to

required
Array of objects non-empty
Array of objects (Custom Field Values)
number
required
integer (Number)

The transaction number

workflow_execution_id
string (Workflow Execution)

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

total
required
number <double> (Total)

The transaction total

business_unit_id
required
string (Business Unit)

The business unit this transaction belongs to

batch_id
required
string (Batch)

The batch this transaction belongs to

cancellation_id
string (Cancellation)

The order cancellation tied to this transaction

order_id
string (Order)

The order tied to this transaction

return_id
string (Return)

The return tied to this transaction

memo
string (Memo)

Memo/description of the transaction

notes
string (Notes)

Notes fro the transaction

date
string <date> (Date)

The date of the transaction

currency_code
string (Currency Code) 3 characters

The currency code in use

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

The currency symbol

exchange_rate
number <double> (Exchange Rate)

The exchange rate, if applicable

total_in_base_currency
required
number <double> (Total In Base Currency)

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

base_currency_code
string (Base Currency Code) 3 characters

The base currency for transactions business unit

base_currency_symbol
string (Base Currency Symbol)

The base symbol for the transactions business unit

sys_search_composite_key
string (Sys Search Composite Key)

Internal use

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 debit memo was saved successfully.
400The debit memo you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The debit memo could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add debit memo based on tenant limits.
500General server error.
post/debitMemos/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "invoice_id": "string",
  • "line_items": [
    ],
  • "custom_field_values": [
    ],
  • "number": 0,
  • "workflow_execution_id": "string",
  • "total": 0,
  • "business_unit_id": "string",
  • "batch_id": "string",
  • "cancellation_id": "string",
  • "order_id": "string",
  • "return_id": "string",
  • "memo": "string",
  • "notes": "string",
  • "date": "2019-08-24",
  • "currency_code": "AED",
  • "currency_symbol": "string",
  • "exchange_rate": 0,
  • "total_in_base_currency": 0,
  • "base_currency_code": "str",
  • "base_currency_symbol": "string",
  • "sys_search_composite_key": "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
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Gets all of the debit memos in the system.

This method will scan all debit memos and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

exclusiveStartKey
string

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

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