Batch Posting

Batch Posting

Initiates workflow to post multiple batches

This method will initiate the batch posting process for one or more supplied batches

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

Paylaod containing the batches to post and other options

business_unit_id
required
string (Business Unit)

The business unit

batch_ids
required
Array of strings (Batches) non-empty

The IDs of the batches to post

Responses
200An execution ARN to be used to monitor the batch posting process.
400The batch record you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
409The batch could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch based on tenant limits.
500General server error
post/batchPosting/{tenantId}/batchPostingRequest
Request samples
application/json
{
  • "business_unit_id": "string",
  • "batch_ids": [
    ]
}
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Initiates workflow to unpost multiple batches

This method will initiate the batch unposting process for one or more supplied batches

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

Paylaod containing the batches to unpost and other options

business_unit_id
required
string (Business Unit)

The business unit

batch_ids
required
Array of strings (Batches) non-empty

The IDs of the batches to post

Responses
200An execution ARN to be used to monitor the batch unposting process.
400The batch record you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
409The batch could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch based on tenant limits.
500General server error
post/batchPosting/{tenantId}/batchUnpostingRequest
Request samples
application/json
{
  • "business_unit_id": "string",
  • "batch_ids": [
    ]
}
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Previews the batch to ensure it can be posted, and reports any errors

Previews the batch to ensure it can be posted, and reports any errors

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

Paylaod containing the batches to unpost and other options

business_unit_id
required
string (Business Unit)

The business unit

batch_ids
required
Array of strings (Batches) non-empty

The IDs of the batches to post

Responses
200An execution ARN to be used to monitor the batch unposting process.
400The batch record you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
409The batch could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch based on tenant limits.
500General server error
post/batchPosting/{tenantId}/batchPostingPreviewRequest
Request samples
application/json
{
  • "business_unit_id": "string",
  • "batch_ids": [
    ]
}
Response samples
application/json
{
  • "products": [
    ],
  • "products_without_financial_configuration": [
    ],
  • "ineligible_batches": [
    ],
  • "batches_to_post": [
    ]
}

Retrieves a subledger entry for a transaction

Retrieves a subledger entry for a transaction

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

batchId
required
string

The id of the batch

transactionId
required
string

The id of the transaction

Responses
200The transaction
400The record you supplied was invalid.
401Unauthorized
403Forbidden
404The subledger entry could not be found
409The could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch based on tenant limits.
500General server error
get/batchPosting/{tenantId}/subledgerEntry/{batchId}/{transactionId}
Request samples
curl -i -X GET \
  https://collect.api.rhythmsoftware.com/batchPosting/:tenantId/subledgerEntry/:batchId/:transactionId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "business_unit_id": "string",
  • "fiscal_year_id": "string",
  • "fiscal_period": 1,
  • "date": "2019-08-24",
  • "batch_id": "string",
  • "cogs_entry_id": "string",
  • "invoice_id": "string",
  • "payment_id": "string",
  • "credit_id": "string",
  • "revenue_recognition_schedule_id": "string",
  • "revenue_recognition_schedule_entry_id": "string",
  • "refund_id": "string",
  • "write_off_id": "string",
  • "gift_id": "string",
  • "inventory_receipt_id": "string",
  • "credit_memo_id": "string",
  • "debit_memo_id": "string",
  • "credit_usage_id": "string",
  • "contact_id": "string",
  • "organization_id": "string",
  • "transaction_type": "string",
  • "transaction_id": "string",
  • "customer_type": "contact",
  • "items": [
    ]
}

Initiates workflow to warm up inventory transactions

Request
Security:
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/batchPosting/warmUpStepFunctions
Request samples
curl -i -X POST \
  https://collect.api.rhythmsoftware.com/batchPosting/warmUpStepFunctions \
  -H 'Authorization: YOUR_API_KEY_HERE'