Claim Invoice Payments

Create ClaimInvoicePayment

Creates a new ClaimInvoicePayment

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

Invoice Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
invoice_Key
required
integer <int32>

Invoice 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

payment_Posted
number or null <double>

Invoice Payment Amount Applied

payment_Posted_Date
string or null <date-time>

Date of Payment applied

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

List ClaimInvoicePayment

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


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


 
claimPaymentKey
required
integer <int32> 
ClaimPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/claim-invoice/{invoiceKey}/payments/{claimPaymentKey}
Request samples 
Response samples 
No sample
Update ClaimInvoicePayment
Updates a specific ClaimInvoicePayment.


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


 
claimPaymentKey
required
integer <int32> 
ClaimPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
invoice_Key
required
integer <int32> 
Invoice 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


 
payment_Posted
number or null <double> 
Invoice Payment Amount Applied


 
payment_Posted_Date
string or null <date-time> 
Date of Payment applied


 
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/{invoiceKey}/payments/{claimPaymentKey}
Request samples 
{
  • "invoice_Key": 0,
  • "claimPayment_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payment_Posted": 0.1,
  • "payment_Posted_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimInvoicePayment
Deletes an ClaimInvoicePayment


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


 
claimPaymentKey
required
integer <int32> 
ClaimPayment Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-invoice/{invoiceKey}/payments/{claimPaymentKey}
Request samples 
Create or Update Batch ClaimInvoicePayment
Create or Update multiple ClaimInvoicePayment 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 
invoice_Key
required
integer <int32> 
Invoice 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


 
payment_Posted
number or null <double> 
Invoice Payment Amount Applied


 
payment_Posted_Date
string or null <date-time> 
Date of Payment applied


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