TAG LINE
SMALL TITLE

Invoice / Item / ReverseCharge

(API Version v3)


Reverses a specific charge of an Invoice Item.


What can you do with InvoiceItem?


Properties

Property Details
identity
READ-ONLY
"identity": 24
Type: Number
This is the unique numeric identifier for the InvoiceItem
accountId
"accountId": 21
Type: Number
Unique identifier for the associated Account object.
accountName
"accountName": "Sample Name"
Type: String
The name of the object associated with the accountId property.
packageId
"packageId": 24
Type: Number
Unique identifier for the associated Package object.
packageName
"packageName": "Sample Name"
Type: String
The name of the object associated with the packageId property.
serviceId
"serviceId": 24
Type: Number
Unique identifier for the associated Service object.
serviceName
"serviceName": "Sample Name"
Type: String
The name of the object associated with the serviceId property.
amount
"amount": 23
Type: Number
The amount that you would like to reverse for the Invoice Item.
detail
"detail": "Hello World"
Type: String
User defined text to be applied to the reversal as a description.
periodStart
"periodStart": "2021-04-26T15:25:27.587Z"
Type: Date
The start date in which this transaction was generated.

Date and time values are specified in the ISO 8601 format.
periodEnd
"periodEnd": "2021-04-26T15:25:27.587Z"
Type: Date
The end date in which this transaction was generated.

Date and time values are specified in the ISO 8601 format.
prorated
"prorated": true
Type: Boolean
Whether or not this charge has been prorated
date
"date": "2021-04-26T15:25:27.587Z"
Type: Date
The date of the charge.

Date and time values are specified in the ISO 8601 format.
accountPackageId
"accountPackageId": "Hello World"
Type: String
Unique identifier for the associated AccountPackage object.
accountPackageName
"accountPackageName": "Sample Name"
Type: String
The name of the object associated with the accountPackageId property.
accountServiceId
"accountServiceId": "Hello World"
Type: String
Unique identifier for the associated AccountService object.
accountServiceName
"accountServiceName": "Sample Name"
Type: String
The name of the object associated with the accountServiceId property.
posting
"posting": "2021-04-26T15:25:27.587Z"
Type: Date
The date for when this charge should be considered posted.

Date and time values are specified in the ISO 8601 format.
invoiceId
"invoiceId": 20
Type: Number
Unique identifier for the associated Invoice object.
invoiceName
"invoiceName": "Sample Name"
Type: String
The name of the object associated with the invoiceId property.
invoiceItemTypeId
"invoiceItemTypeId": 25
Type: Number
Unique identifier for the associated InvoiceItemType object.
invoiceItemTypeName
"invoiceItemTypeName": "Sample Name"
Type: String
The name of the object associated with the invoiceItemTypeId property.
isTaxExempt
"isTaxExempt": true
Type: Boolean
Whether or not this charge is tax exempt.
baseAmount
"baseAmount": 17
Type: Number
The total amount of the transaction charge in the Base/Owner currency.
invoiceAmount
"invoiceAmount": 3
Type: Number
The total amount of the transaction charge rounded to the currency precision.
invoiceCurrencyExchangeDetailId
"invoiceCurrencyExchangeDetailId": 1
Type: Number
Unique identifier for the associated CurrencyExchangeDetail object.
invoiceCurrencyExchangeDetailName
"invoiceCurrencyExchangeDetailName": "Sample Name"
Type: String
The name of the object associated with the invoiceCurrencyExchangeDetailId property.
originalInvoiceItemId
"originalInvoiceItemId": 6
Type: Number
A reference to the original transaction that was part of a previous voided invoice.

Unique identifier for the associated InvoiceItem object.
originalInvoiceItemName
"originalInvoiceItemName": "Sample Name"
Type: String
The name of the object associated with the originalInvoiceItemId property.
isManual
"isManual": true
Type: Boolean
Whether or not this charge was a user manually added charge.
createdByUserId
"createdByUserId": 25
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
udrUsageIdentifier
"udrUsageIdentifier": "Hello World"
Type: String
The unique usage identifier assigned to the Service that was charged.
accountServiceTemporalId
"accountServiceTemporalId": "Hello World"
Type: String
Unique identifier for the associated AccountServiceTemporal object.
accountServiceTemporalName
"accountServiceTemporalName": "Sample Name"
Type: String
The name of the object associated with the accountServiceTemporalId property.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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

End Points

POSTapi/v3/Invoice/Item/ReverseCharge/
Create a new instance of the InvoiceItem object.
Create a new instance of the InvoiceItem object.
POST api/v3/Invoice/Item/ReverseCharge/

{
    "accountId": 2,
    "packageId": 8,
    "serviceId": 17,
    "amount": 6,
    "detail": "Sample Text Data",
    "periodStart": "2021-04-26T15:25:27.587Z",
    "periodEnd": "2021-04-26T15:25:27.587Z",
    "prorated": true,
    "date": "2021-04-26T15:25:27.587Z",
    "accountPackageId": "Sample Text Data",
    "accountServiceId": "Sample Text Data",
    "posting": "2021-04-26T15:25:27.587Z",
    "invoiceId": 11,
    "invoiceItemTypeId": 5,
    "isTaxExempt": true,
    "baseAmount": 22,
    "invoiceAmount": 1,
    "invoiceCurrencyExchangeDetailId": 27,
    "originalInvoiceItemId": 17,
    "isManual": true,
    "createdByUserId": 17,
    "udrUsageIdentifier": "Sample Text Data",
    "accountServiceTemporalId": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 27,
                "accountName": "Sample Text Data",
                "packageId": 20,
                "packageName": "Sample Text Data",
                "serviceId": 19,
                "serviceName": "Sample Text Data",
                "amount": 16,
                "detail": "Sample Text Data",
                "periodStart": "2021-04-26T15:25:27.587Z",
                "periodEnd": "2021-04-26T15:25:27.587Z",
                "prorated": true,
                "date": "2021-04-26T15:25:27.587Z",
                "accountPackageId": "Sample Text Data",
                "accountPackageName": "Sample Text Data",
                "accountServiceId": "Sample Text Data",
                "accountServiceName": "Sample Text Data",
                "posting": "2021-04-26T15:25:27.587Z",
                "invoiceId": 23,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 7,
                "invoiceItemTypeName": "Sample Text Data",
                "isTaxExempt": true,
                "baseAmount": 18,
                "invoiceAmount": 12,
                "invoiceCurrencyExchangeDetailId": 12,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 26,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 21,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data"
            }
        ]
    }
}