Invoice / Item

What can you do with InvoiceItem?


Properties

Property Details
id
"id": 658
Type: Number
This is the unique numeric identifier for the InvoiceItem
accountId
"accountId": 702
Type: Number
Unique identifier for the associated Account object.
packageId
"packageId": 623
Type: Number
Unique identifier for the associated Package object.
serviceId
"serviceId": 656
Type: Number
Unique identifier for the associated Service object.
amount
"amount": "Hello World"
Type: String
detail
"detail": "Hello World"
Type: String
periodStart
"periodStart": "2005-04-11T14:56:24"
Type: Date
periodEnd
"periodEnd": "2005-04-11T14:56:24"
Type: Date
prorated
"prorated": true
Type: Boolean
credit
"credit": true
Type: Boolean
date
"date": "2005-04-11T14:56:24"
Type: Date
accountPackageId
"accountPackageId": 164
Type: Number
Unique identifier for the associated AccountPackage object.
accountServiceId
"accountServiceId": 436
Type: Number
Unique identifier for the associated AccountService object.
glCode
"glCode": "Hello World"
Type: String
createdByAccountId
"createdByAccountId": 510
Type: Number
Unique identifier for the associated Account object.
posting
"posting": "2005-04-11T14:56:24"
Type: Date
bulkQuantity
"bulkQuantity": 44
Type: Number
accountingExportStagingId
"accountingExportStagingId": 849
Type: Number
Unique identifier for the associated AccountingExportStaging object.
nonRefundable
"nonRefundable": true
Type: Boolean
invoiceId
"invoiceId": 115
Type: Number
Unique identifier for the associated Invoice object.
invoiceItemTypeId
"invoiceItemTypeId": 282
Type: Number
Unique identifier for the associated InvoiceItemType object.
automaticDisbursement
"automaticDisbursement": true
Type: Boolean
isTaxExempt
"isTaxExempt": true
Type: Boolean
baseAmount
"baseAmount": "Hello World"
Type: String
invoiceAmount
"invoiceAmount": "Hello World"
Type: String
invoiceCurrencyExchangeDetailId
"invoiceCurrencyExchangeDetailId": 369
Type: Number
Unique identifier for the associated CurrencyExchangeDetail object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • accountId
  • packageId
  • serviceId
  • amount
  • detail
  • periodStart
  • periodEnd
  • prorated
  • credit
  • date
  • accountPackageId
  • accountServiceId
  • gLCode
  • createdByAccountId
  • posting
  • bulkQuantity
  • accountingExportStagingId
  • nonRefundable
  • invoiceId
  • invoiceItemTypeId
  • automaticDisbursement
  • isTaxExempt
  • baseAmount
  • invoiceAmount
  • invoiceCurrencyExchangeDetailId

DataFlow PATCH objects:


End Points

DELETEapi/v1/Invoice/Item/{id:int}
Delete an instance of the InvoiceItem object.
GETapi/v1/Invoice/Item
Retrieve all of the InvoiceItem objects.
GETapi/v1/Invoice/Item/Metadata
Retrieve all of the meta data details of the InvoiceItem object.
GETapi/v1/Invoice/Item/Metadata/{option}
Retrieve all the meta data details of the InvoiceItem object based on provided options.
{option}Metadata options for the InvoiceItem object.
GETapi/v1/Invoice/Item/Paged
Retreive all of the InvoiceItem objects in a paged fashion.
GETapi/v1/Invoice/Item/Paged/Detail
Retreive all of the InvoiceItem objects in a paged fashion with all object details.
GETapi/v1/Invoice/Item/{id:int}
Retrieve an instance of the InvoiceItem object by it's ID.
{id:int}Unique identifier for the InvoiceItem object.
GETapi/v1/Invoice/Item/{id:int}/Detail
Retreive all of the Detail objects for the specified InvoiceItem.
{id:int}Unique identifier for the InvoiceItem object.
PATCHapi/v1/Invoice/Item/{id:int}
Update the InvoiceItem object and optionally make changes to any child objects.
POSTapi/v1/Invoice/Item
Create a new instance of the InvoiceItem object.
PUTapi/v1/Invoice/Item/{id:int}
Update an existing instance of the InvoiceItem object.