Suspense Claims

Create SuspenseClaim

Creates a new SuspenseClaim

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
suspenseClaim_Key
required
integer <int32>
claim_Number
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
suspenseCriteria_Key
required
integer <int32>
suspense_Date
string or null <date-time>
suspense_Status
string or null <= 16 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/suspense-claims
Request samples
{
  • "suspenseClaim_Key": 0,
  • "claim_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "suspenseCriteria_Key": 0,
  • "suspense_Date": "2019-08-24T14:15:22Z",
  • "suspense_Status": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SuspenseClaim

Lists all SuspenseClaim

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/suspense-claims
Request samples
Response samples
No sample

Get SuspenseClaim

Gets SuspenseClaim

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
suspenseClaimKey
required
integer <int32>

SuspenseClaim Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/suspense-claims/{suspenseClaimKey}
Request samples
Response samples
No sample

Update SuspenseClaim

Updates a specific SuspenseClaim.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
suspenseClaimKey
required
integer <int32>

SuspenseClaim Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
suspenseClaim_Key
required
integer <int32>
claim_Number
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
suspenseCriteria_Key
required
integer <int32>
suspense_Date
string or null <date-time>
suspense_Status
string or null <= 16 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

put/suspense-claims/{suspenseClaimKey}
Request samples
{
  • "suspenseClaim_Key": 0,
  • "claim_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "suspenseCriteria_Key": 0,
  • "suspense_Date": "2019-08-24T14:15:22Z",
  • "suspense_Status": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete SuspenseClaim

Deletes an SuspenseClaim

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
suspenseClaimKey
required
integer <int32>

SuspenseClaim Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/suspense-claims/{suspenseClaimKey}
Request samples

Create or Update Batch SuspenseClaim

Create or Update multiple SuspenseClaim at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
suspenseClaim_Key
required
integer <int32>
claim_Number
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
suspenseCriteria_Key
required
integer <int32>
suspense_Date
string or null <date-time>
suspense_Status
string or null <= 16 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
207

Success

401

Unauthorized

put/suspense-claims-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}