Skip to main content
POST
/
api
/
payments-received
/
validate-bulk-delete
Validates which payments received can be deleted and returns the results.
curl --request POST \
  --url https://api.example.com/api/payments-received/validate-bulk-delete \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "ids": [
    1,
    2,
    3
  ],
  "skipUndeletable": false
}
'
{
  "deletableCount": 2,
  "nonDeletableCount": 1,
  "deletableIds": [
    1,
    2
  ],
  "nonDeletableIds": [
    3
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
​
ids
number[]
required

Array of IDs to delete

Example:
[1, 2, 3]
​
skipUndeletable
boolean
default:false

When true, undeletable items will be skipped and only deletable ones will be removed.

Response

200 - application/json

Validation completed with counts and IDs of deletable and non-deletable payments received.

​
deletableCount
number
required

Number of items that can be deleted

Example:

2

​
nonDeletableCount
number
required

Number of items that cannot be deleted

Example:

1

​
deletableIds
number[]
required

IDs of items that can be deleted

Example:
[1, 2]
​
nonDeletableIds
number[]
required

IDs of items that cannot be deleted

Example:
[3]