Financials
Financial Cases

Create a new financial spreading case

Provide either external_customer_id or customer_id to create the case. The limit for number of documents in a case is 30. This endpoint is rate-limited to 30 transactions per minute (TPM) per organization by default. If you require a higher rate limit, please contact Accend Support. If the idempotency key matches an existing case for the same customer, the case will be returned and no new case will be created. If existing case is cancelled, the case will be reopened.

In the STAGING environment, the 'X-Accend-Test' header flag enables the creation of test cases that are automatically closed with a mock result. In production, the header is only allowed for designated test orgs.

post/api/v1/financials/cases

Request

  • Base URL: https://api.withaccend.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withaccend.com/api/v1/financials/cases
  • Auth: none declared

Headers

x-accend-teststring nullable

Test flag for the case creation, if set, the case will be closed with mock result. Only available in STAGING environment.

Request body

OR
OR

Response

Successful Response

case_idstring required

Case ID in our system

document_idsstring[] required

List of document IDs for the case

customer_idstring nullable required

Customer ID in our system for the customer the case belongs to

external_customer_idstring nullable

external customer id for the customer the case belongs to

asset_idstring nullable

Asset ID in our system for the asset the case belongs to

case_namestring nullable

Case name

case_priorityinteger nullable

Case priority

prepare_by'accend' | 'self_prepared'
case_status'pending' | 'processing' | 'waiting_on_client' | 'completed' | 'cancelled' | 'waiting_on_end_customer' required

Case status

review_type'initiation' | 'monthly' | 'quarterly' | 'semi_annually' | 'annually' | 'ad-hoc' nullable
created_atstring date-time required

Case creation time in ISO format

Changes

No recorded changes to this operation across all 1 revision of this API.