Claim Invoice

Create ClaimInvoice

Creates a new ClaimInvoice

SecurityapiKeyAuth and bearerAuth
Request
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.

description
string or null

Description for the Invoice

due_Date
string or null <date-time>

Due Date of the Invoice

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_Date
string or null <date-time>

Invoice Date for the Invoice

invoice_Number
string or null <= 32 characters

Unique identifier Invoice Number

invoice_Status
string or null <= 16 characters

Status of the Invoice

payee_ID
string or null <= 20 characters

Payee of the Invoice

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
Request samples
{
  • "invoice_Key": 0,
  • "description": "string",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "invoice_Number": "string",
  • "invoice_Status": "string",
  • "payee_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ClaimInvoice

Lists all ClaimInvoice

SecurityapiKeyAuth and bearerAuth
Request
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
Request samples 
Response samples 
No sample
Get ClaimInvoice
Gets ClaimInvoice


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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.


 
description
string or null
Description for the Invoice


 
due_Date
string or null <date-time> 
Due Date of the Invoice


 
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_Date
string or null <date-time> 
Invoice Date for the Invoice


 
invoice_Number
string or null  <= 32 characters 
Unique identifier Invoice Number


 
invoice_Status
string or null  <= 16 characters 
Status of the Invoice


 
payee_ID
string or null  <= 20 characters 
Payee of the Invoice


 
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}
Request samples 
{
  • "invoice_Key": 0,
  • "description": "string",
  • "due_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "invoice_Date": "2019-08-24T14:15:22Z",
  • "invoice_Number": "string",
  • "invoice_Status": "string",
  • "payee_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ClaimInvoice
Deletes an ClaimInvoice


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/claim-invoice/{invoiceKey}
Request samples 
Create or Update Batch ClaimInvoice
Create or Update multiple ClaimInvoice 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 
invoice_Key
required
integer <int32> 
Invoice Identifier Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null
Description for the Invoice


 
due_Date
string or null <date-time> 
Due Date of the Invoice


 
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_Date
string or null <date-time> 
Invoice Date for the Invoice


 
invoice_Number
string or null  <= 32 characters 
Unique identifier Invoice Number


 
invoice_Status
string or null  <= 16 characters 
Status of the Invoice


 
payee_ID
string or null  <= 20 characters 
Payee of the Invoice


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