Claim Invoice Received

Create ClaimInvoiceReceived

Creates a new ClaimInvoiceReceived

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
claimInvoiceReceived_Key
required
integer <int32>

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

claimPayment_Key
required
integer <int32>

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

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.

received_Amount
number or null <double>

Amount of the Payment Received

received_Date
string or null <date-time>

Date the Payment Received

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-received
Request samples
{
  • "claimInvoiceReceived_Key": 0,
  • "claimPayment_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Key": 0,
  • "received_Amount": 0.1,
  • "received_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimInvoiceReceived

Lists all ClaimInvoiceReceived 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}/received
Request samples 
Response samples 
No sample
Get ClaimInvoiceReceived
Gets ClaimInvoiceReceived


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimInvoiceReceivedKey
required
integer <int32> 
ClaimInvoiceReceived Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-invoice-received/{claimInvoiceReceivedKey}
Request samples 
Response samples 
No sample
Update ClaimInvoiceReceived
Updates a specific ClaimInvoiceReceived.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimInvoiceReceivedKey
required
integer <int32> 
ClaimInvoiceReceived Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
claimPayment_Key
required
integer <int32> 
Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
received_Amount
number or null <double> 
Amount of the Payment Received


 
received_Date
string or null <date-time> 
Date the Payment Received


 
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-received/{claimInvoiceReceivedKey}
Request samples 
{
  • "claimInvoiceReceived_Key": 0,
  • "claimPayment_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Key": 0,
  • "received_Amount": 0.1,
  • "received_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimInvoiceReceived
Deletes an ClaimInvoiceReceived


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
claimInvoiceReceivedKey
required
integer <int32> 
ClaimInvoiceReceived Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-invoice-received/{claimInvoiceReceivedKey}
Request samples 
Create or Update Batch ClaimInvoiceReceived
Create or Update multiple ClaimInvoiceReceived 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 
claimInvoiceReceived_Key
required
integer <int32> 
Unique Claim Invoice Received identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
claimPayment_Key
required
integer <int32> 
Unique Payment identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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.


 
received_Amount
number or null <double> 
Amount of the Payment Received


 
received_Date
string or null <date-time> 
Date the Payment Received


 
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}/received-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}