Claim Invoice Adjustments

Create ClaimInvoiceAdjustment

Creates a new ClaimInvoiceAdjustment

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimInvoiceAdjustment_Key
required
integer <int32>

Unique Claim Invoice Adjustment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.

adjustment_Amount
number or null <double>

Amount of the Claim Invoice Adjustment

adjustment_Date
string or null <date-time>

Date the Claim Invoice Adjustment

adjustment_Reason
integer or null <int32>

Reason of the Claim Invoice Adjustment

batch_Claim
integer or null <int32>

Claim Batch Claim Identifier

batch_Number
integer or null <int32>

Claim Batch Number Identifier

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

invoice_Key
required
integer <int32>

Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/claim-invoice-adjustments
Request samples
{
  • "claimInvoiceAdjustment_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Date": "2019-08-24T14:15:22Z",
  • "adjustment_Reason": 0,
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimInvoiceAdjustment

Lists all ClaimInvoiceAdjustment for the given invoiceKey

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

Invoice Key

query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/claim-invoice/{invoiceKey}/adjustments
Request samples 
Response samples 
No sample
Get ClaimInvoiceAdjustment
Gets ClaimInvoiceAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimInvoiceAdjustmentKey
required
integer <int32> 
ClaimInvoiceAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-invoice-adjustments/{claimInvoiceAdjustmentKey}
Request samples 
Response samples 
No sample
Update ClaimInvoiceAdjustment
Updates a specific ClaimInvoiceAdjustment.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimInvoiceAdjustmentKey
required
integer <int32> 
ClaimInvoiceAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
claimInvoiceAdjustment_Key
required
integer <int32> 
Unique Claim Invoice Adjustment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjustment_Amount
number or null <double> 
Amount of the Claim Invoice Adjustment


 
adjustment_Date
string or null <date-time> 
Date the Claim Invoice Adjustment


 
adjustment_Reason
integer or null <int32> 
Reason of the Claim Invoice Adjustment


 
batch_Claim
integer or null <int32> 
Claim Batch Claim Identifier


 
batch_Number
integer or null <int32> 
Claim Batch Number Identifier


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
invoice_Key
required
integer <int32> 
Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/claim-invoice-adjustments/{claimInvoiceAdjustmentKey}
Request samples 
{
  • "claimInvoiceAdjustment_Key": 0,
  • "adjustment_Amount": 0.1,
  • "adjustment_Date": "2019-08-24T14:15:22Z",
  • "adjustment_Reason": 0,
  • "batch_Claim": 0,
  • "batch_Number": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimInvoiceAdjustment
Deletes an ClaimInvoiceAdjustment


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimInvoiceAdjustmentKey
required
integer <int32> 
ClaimInvoiceAdjustment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-invoice-adjustments/{claimInvoiceAdjustmentKey}
Request samples 
Create or Update Batch ClaimInvoiceAdjustment
Create or Update multiple ClaimInvoiceAdjustment at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
invoiceKey
required
integer <int32> 
Invoice Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
claimInvoiceAdjustment_Key
required
integer <int32> 
Unique Claim Invoice Adjustment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
adjustment_Amount
number or null <double> 
Amount of the Claim Invoice Adjustment


 
adjustment_Date
string or null <date-time> 
Date the Claim Invoice Adjustment


 
adjustment_Reason
integer or null <int32> 
Reason of the Claim Invoice Adjustment


 
batch_Claim
integer or null <int32> 
Claim Batch Claim Identifier


 
batch_Number
integer or null <int32> 
Claim Batch Number Identifier


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
invoice_Key
required
integer <int32> 
Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/claim-invoice/{invoiceKey}/adjustments-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}