Invoice / Item / ReverseCharge

What can you do with InvoiceItem?


Properties

Property Details
id
"id": 897
Type: Number
This is the unique numeric identifier for the InvoiceItem
accountId
"accountId": 71
Type: Number
Unique identifier for the associated Account object.
packageId
"packageId": 855
Type: Number
Unique identifier for the associated Package object.
serviceId
"serviceId": 714
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
date
"date": "2005-04-11T14:56:24"
Type: Date
accountPackageId
"accountPackageId": "Hello World"
Type: String
Unique identifier for the associated AccountPackage object.
accountServiceId
"accountServiceId": "Hello World"
Type: String
Unique identifier for the associated AccountService object.
posting
"posting": "2005-04-11T14:56:24"
Type: Date
invoiceId
"invoiceId": 132
Type: Number
Unique identifier for the associated Invoice object.
invoiceItemTypeId
"invoiceItemTypeId": 563
Type: Number
Unique identifier for the associated InvoiceItemType object.
isTaxExempt
"isTaxExempt": true
Type: Boolean
baseAmount
"baseAmount": "Hello World"
Type: String
invoiceAmount
"invoiceAmount": "Hello World"
Type: String
invoiceCurrencyExchangeDetailId
"invoiceCurrencyExchangeDetailId": 280
Type: Number
Unique identifier for the associated CurrencyExchangeDetail object.
originalInvoiceItemId
"originalInvoiceItemId": 538
Type: Number
Unique identifier for the associated InvoiceItem object.
isManual
"isManual": true
Type: Boolean
createdByUserId
"createdByUserId": 199
Type: Number
Unique identifier for the associated User object.
udrUsageIdentifier
"udrUsageIdentifier": "Hello World"
Type: String
accountServiceTemporalId
"accountServiceTemporalId": "Hello World"
Type: String
Unique identifier for the associated AccountServiceTemporal 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:

  • identity
  • accountId
  • packageId
  • serviceId
  • amount
  • detail
  • periodStart
  • periodEnd
  • prorated
  • date
  • accountPackageId
  • accountServiceId
  • posting
  • invoiceId
  • invoiceItemTypeId
  • isTaxExempt
  • baseAmount
  • invoiceAmount
  • invoiceCurrencyExchangeDetailId
  • originalInvoiceItemId
  • isManual
  • createdByUserId
  • udrUsageIdentifier
  • accountServiceTemporalId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the InvoiceItem object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

GETapi/v1/Invoice/Item/ReverseCharge
Retrieve all of the InvoiceItem objects.
GETapi/v1/Invoice/Item/ReverseCharge/Metadata
Retrieve all of the meta data details of the InvoiceItem object.
GETapi/v1/Invoice/Item/ReverseCharge/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/ReverseCharge/Paged
Retreive all of the InvoiceItem objects in a paged fashion.
GETapi/v1/Invoice/Item/ReverseCharge/{id:int}
Retrieve an instance of the InvoiceItem object by it's ID.
{id:int}Unique identifier for the InvoiceItem object.
POSTapi/v1/Invoice/Item/ReverseCharge
Create a new instance of the InvoiceItem object.
PUTapi/v1/Invoice/Item/ReverseCharge/{id:int}
Update an existing instance of the InvoiceItem object.