TAG LINE
TAG LINE
SMALL TITLE

Invoice / Item

(API Version v5)


This is the billing transaction that is associated with an Invoice.


What can you do with InvoiceItem?


Properties

Property Details
identity
READ-ONLY
"identity": 7
Type: Number
This is the unique numeric identifier for the InvoiceItem
accountId
"accountId": 1
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": 27
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": 3
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": 10
Type: Number
The total amount of the transaction charge.
detail
"detail": "Hello World"
Type: String
User defined or system generated description for the transaction.
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": 16
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": 4
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.
baseAmount
"baseAmount": 19
Type: Number
The total amount of the transaction charge in the Base/Owner currency.
invoiceAmount
"invoiceAmount": 16
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": 17
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": 6
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.
quantity
"quantity": 14
Type: Number
price
"price": 26
Type: Number


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:

  • creditInvoiceDisbursement - create, update, delete
  • invoiceItemTax - create, update, delete

DataFlow PATCH objects:

  • invoiceItem - create, update, delete
  • creditInvoiceDisbursement - create, update, delete
  • invoiceItemTax - create, update, delete

End Points

DELETEInvoice/Item/{id}
Delete an instance of the InvoiceItem object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the InvoiceItem object.
Delete an instance of the InvoiceItem object.
DELETE Invoice/Item/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "invoiceItem"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETInvoice/Item/
Retrieve all of the InvoiceItem objects.
Retrieve all of the InvoiceItem objects.
GET Invoice/Item/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountId": 3,
            "accountName": "Sample Text Data",
            "packageId": 23,
            "packageName": "Sample Text Data",
            "serviceId": 16,
            "serviceName": "Sample Text Data",
            "amount": 22,
            "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": 11,
            "invoiceName": "Sample Text Data",
            "invoiceItemTypeId": 11,
            "invoiceItemTypeName": "Sample Text Data",
            "baseAmount": 9,
            "invoiceAmount": 18,
            "invoiceCurrencyExchangeDetailId": 20,
            "invoiceCurrencyExchangeDetailName": "Sample Text Data",
            "originalInvoiceItemId": 17,
            "originalInvoiceItemName": "Sample Text Data",
            "isManual": true,
            "createdByUserId": 26,
            "createdByUserName": "Sample Text Data",
            "udrUsageIdentifier": "Sample Text Data",
            "accountServiceTemporalId": "Sample Text Data",
            "accountServiceTemporalName": "Sample Text Data",
            "quantity": 7,
            "price": 25
        }
    ]
}
GETInvoice/Item/Paged
Retrieve all of the InvoiceItem objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the InvoiceItem objects in a paged fashion.
GET Invoice/Item/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 9,
                "accountName": "Sample Text Data",
                "packageId": 26,
                "packageName": "Sample Text Data",
                "serviceId": 14,
                "serviceName": "Sample Text Data",
                "amount": 12,
                "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": 27,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 10,
                "invoiceItemTypeName": "Sample Text Data",
                "baseAmount": 3,
                "invoiceAmount": 1,
                "invoiceCurrencyExchangeDetailId": 0,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 26,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 22,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data",
                "quantity": 14,
                "price": 12
            }
        ]
    }
}
GETInvoice/Item/Paged/Detail
Retrieve all of the InvoiceItem objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the InvoiceItem objects in a paged fashion with all object details.
GET Invoice/Item/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 11,
                "accountName": "Sample Text Data",
                "packageId": 1,
                "packageName": "Sample Text Data",
                "serviceId": 24,
                "serviceName": "Sample Text Data",
                "amount": 5,
                "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": 12,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 17,
                "invoiceItemTypeName": "Sample Text Data",
                "baseAmount": 25,
                "invoiceAmount": 26,
                "invoiceCurrencyExchangeDetailId": 20,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 4,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 14,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data",
                "quantity": 4,
                "price": 26,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETInvoice/Item/{id}
Retrieve an instance of the InvoiceItem object by its ID.
{id}Unique identifier for the InvoiceItem object.
Retrieve an instance of the InvoiceItem object by its ID.
GET Invoice/Item/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 5,
        "accountName": "Sample Text Data",
        "packageId": 2,
        "packageName": "Sample Text Data",
        "serviceId": 14,
        "serviceName": "Sample Text Data",
        "amount": 15,
        "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": 9,
        "invoiceName": "Sample Text Data",
        "invoiceItemTypeId": 11,
        "invoiceItemTypeName": "Sample Text Data",
        "baseAmount": 21,
        "invoiceAmount": 4,
        "invoiceCurrencyExchangeDetailId": 4,
        "invoiceCurrencyExchangeDetailName": "Sample Text Data",
        "originalInvoiceItemId": 6,
        "originalInvoiceItemName": "Sample Text Data",
        "isManual": true,
        "createdByUserId": 4,
        "createdByUserName": "Sample Text Data",
        "udrUsageIdentifier": "Sample Text Data",
        "accountServiceTemporalId": "Sample Text Data",
        "accountServiceTemporalName": "Sample Text Data",
        "quantity": 22,
        "price": 12
    }
}
GETInvoice/Item/{id}/Detail
Retrieve deep detail of the InvoiceItem object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the InvoiceItem object.
Retrieve deep detail of the InvoiceItem object by its ID.
GET Invoice/Item/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 19,
        "accountName": "Sample Text Data",
        "packageId": 25,
        "packageName": "Sample Text Data",
        "serviceId": 17,
        "serviceName": "Sample Text Data",
        "amount": 1,
        "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": 3,
        "invoiceName": "Sample Text Data",
        "invoiceItemTypeId": 1,
        "invoiceItemTypeName": "Sample Text Data",
        "baseAmount": 3,
        "invoiceAmount": 17,
        "invoiceCurrencyExchangeDetailId": 23,
        "invoiceCurrencyExchangeDetailName": "Sample Text Data",
        "originalInvoiceItemId": 24,
        "originalInvoiceItemName": "Sample Text Data",
        "isManual": true,
        "createdByUserId": 1,
        "createdByUserName": "Sample Text Data",
        "udrUsageIdentifier": "Sample Text Data",
        "accountServiceTemporalId": "Sample Text Data",
        "accountServiceTemporalName": "Sample Text Data",
        "quantity": 26,
        "price": 2,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHInvoice/Item/TaxAdjustment/{id}
Update or Add the InvoiceItem object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the InvoiceItem object.
Update or Add the InvoiceItem object and optionally make changes to any child objects.
PATCH Invoice/Item/TaxAdjustment/{id}

{
    "details": {},
    "invoiceItems": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "accountId": 13,
                "packageId": 8,
                "serviceId": 24,
                "amount": 15,
                "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": 26,
                "invoiceItemTypeId": 18,
                "baseAmount": 19,
                "invoiceAmount": 24,
                "invoiceCurrencyExchangeDetailId": 20,
                "originalInvoiceItemId": 18,
                "isManual": true,
                "createdByUserId": 10,
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "quantity": 25,
                "price": 21
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "invoiceItem",
                "instance": {
                    "identity": 1,
                    "accountId": 12,
                    "accountName": "Sample Text Data",
                    "packageId": 24,
                    "packageName": "Sample Text Data",
                    "serviceId": 16,
                    "serviceName": "Sample Text Data",
                    "amount": 13,
                    "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": 6,
                    "invoiceName": "Sample Text Data",
                    "invoiceItemTypeId": 4,
                    "invoiceItemTypeName": "Sample Text Data",
                    "baseAmount": 14,
                    "invoiceAmount": 14,
                    "invoiceCurrencyExchangeDetailId": 26,
                    "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                    "originalInvoiceItemId": 12,
                    "originalInvoiceItemName": "Sample Text Data",
                    "isManual": true,
                    "createdByUserId": 21,
                    "createdByUserName": "Sample Text Data",
                    "udrUsageIdentifier": "Sample Text Data",
                    "accountServiceTemporalId": "Sample Text Data",
                    "accountServiceTemporalName": "Sample Text Data",
                    "quantity": 2,
                    "price": 23
                }
            }
        ]
    }
}
PATCHInvoice/Item/{id}
Update or Add the InvoiceItem object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the InvoiceItem object.
Update or Add the InvoiceItem object and optionally make changes to any child objects.
PATCH Invoice/Item/{id}

{
    "details": {},
    "invoiceItems": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "accountId": 3,
                "packageId": 12,
                "serviceId": 17,
                "amount": 9,
                "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": 26,
                "invoiceItemTypeId": 2,
                "baseAmount": 17,
                "invoiceAmount": 6,
                "invoiceCurrencyExchangeDetailId": 0,
                "originalInvoiceItemId": 17,
                "isManual": true,
                "createdByUserId": 22,
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "quantity": 1,
                "price": 14
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "invoiceItem",
                "instance": {
                    "identity": 1,
                    "accountId": 1,
                    "accountName": "Sample Text Data",
                    "packageId": 11,
                    "packageName": "Sample Text Data",
                    "serviceId": 24,
                    "serviceName": "Sample Text Data",
                    "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",
                    "accountPackageName": "Sample Text Data",
                    "accountServiceId": "Sample Text Data",
                    "accountServiceName": "Sample Text Data",
                    "posting": "2021-04-26T15:25:27.587Z",
                    "invoiceId": 16,
                    "invoiceName": "Sample Text Data",
                    "invoiceItemTypeId": 19,
                    "invoiceItemTypeName": "Sample Text Data",
                    "baseAmount": 27,
                    "invoiceAmount": 9,
                    "invoiceCurrencyExchangeDetailId": 10,
                    "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                    "originalInvoiceItemId": 5,
                    "originalInvoiceItemName": "Sample Text Data",
                    "isManual": true,
                    "createdByUserId": 23,
                    "createdByUserName": "Sample Text Data",
                    "udrUsageIdentifier": "Sample Text Data",
                    "accountServiceTemporalId": "Sample Text Data",
                    "accountServiceTemporalName": "Sample Text Data",
                    "quantity": 21,
                    "price": 27
                }
            }
        ]
    }
}
POSTInvoice/Item/
Create a new instance of the InvoiceItem object.
Create a new instance of the InvoiceItem object.
POST Invoice/Item/

{
    "accountId": 21,
    "packageId": 26,
    "serviceId": 11,
    "amount": 27,
    "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": 26,
    "invoiceItemTypeId": 18,
    "baseAmount": 16,
    "invoiceAmount": 19,
    "invoiceCurrencyExchangeDetailId": 25,
    "originalInvoiceItemId": 15,
    "isManual": true,
    "createdByUserId": 15,
    "udrUsageIdentifier": "Sample Text Data",
    "accountServiceTemporalId": "Sample Text Data",
    "quantity": 0,
    "price": 21
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 2,
                "accountName": "Sample Text Data",
                "packageId": 18,
                "packageName": "Sample Text Data",
                "serviceId": 10,
                "serviceName": "Sample Text Data",
                "amount": 0,
                "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": 6,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 8,
                "invoiceItemTypeName": "Sample Text Data",
                "baseAmount": 22,
                "invoiceAmount": 3,
                "invoiceCurrencyExchangeDetailId": 8,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 13,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 18,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data",
                "quantity": 9,
                "price": 2
            }
        ]
    }
}
POSTInvoice/Item/Credit
Create an InvoiceItem that is a Credit. The Credit Resource has only the necessary properties to create a credit. This is typically easier to use than an InvoiceItem.
Create an InvoiceItem that is a Credit.
POST Invoice/Item/Credit

{
  "accountId": 153,
  "accountName": "admin",
  "amount": -10, 
  "date": null,
  "posting": null,
  "serviceId": 1,
  "serviceName": "", 
  "detail": "Hotel Gelf",
  "periodStart": null,
  "periodEnd": null,
  "showOnInvoice": true,
  "showOnCreditNote": true,
  "details": {
    "creditDisbursements": {
      "items": [
        {
          "invoiceId": 18332,
          "amount": 10
        }
      ]
    }
  }
}
View Sample Response
HTTP/1.1 200 OK
{
  "trackingId": "53064b3f-a018-4dd2-96a1-793e07e4e3a6",
  "type": "create",
  "results": {
    "totalCount": 6,
    "items": [
      {
        "identity": 11,
        "action": "created",
        "dtoTypeKey": "invoiceItem",
        "instance": {
          "identity": 11,
          "accountId": 153,
          "accountName": "admin",
          "serviceId": 1,
          "serviceName": "Extreme DSL Service",
          "amount": -10,
          "detail": "Hotel Gelf",
          "periodStart": "2019-08-13T00:00:00",
          "periodEnd": "2019-08-13T00:00:00",
          "credit": true,
          "date": "2019-08-13T00:00:00",
          "posting": "2019-08-13T00:00:00",
          "bulkQuantity": 0,
          "nonRefundable": false,
          "invoiceItemTypeId": 2,
          "invoiceItemTypeName": "Credit",
          "automaticDisbursement": false,
          "isTaxExempt": false,
          "isManual": true,
          "createdByUserId": 153,
          "createdByUserName": "admin"
        }
      },
      {
        "identity": 15,
        "action": "created",
        "dtoTypeKey": "invoiceItemTax",
        "instance": {
          "identity": 15,
          "invoiceItemId": 11,
          "amount": -0.8,
          "taxRateId": 187,
          "taxRateName": "GST",
          "taxCodeId": 1,
          "taxCodeName": "Canada",
          "amountReportable": 0
        }
      },
      {
        "identity": 16,
        "action": "created",
        "dtoTypeKey": "invoiceItemTax",
        "instance": {
          "identity": 16,
          "invoiceItemId": 11,
          "amount": -0.7,
          "taxRateId": 188,
          "taxRateName": "PST",
          "taxCodeId": 1,
          "taxCodeName": "Canada",
          "amountReportable": 0
        }
      },
      {
        "identity": 4,
        "action": "created",
        "dtoTypeKey": "creditInvoiceDisbursement",
        "instance": {
          "identity": 4,
          "invoiceId": 18332,
          "invoiceName": "18332",
          "amount": 10,
          "invoiceItemId": 11,
          "baseAmount": 10,
          "invoiceAmount": 10
        }
      },
      {
        "identity": 18332,
        "action": "updated",
        "dtoTypeKey": "invoice"
      },
      {
        "identity": 4,
        "action": "created",
        "dtoTypeKey": "creditItem",
        "instance": {
          "identity": 4,
          "invoiceItemId": 11,
          "showOnInvoice": true,
          "showOnCreditNote": true
        }
      }
    ]
  }
}
POSTInvoice/Item/ReverseCharge
Create a new instance of the InvoiceItem object.
Create a new instance of the InvoiceItem object.
POST Invoice/Item/ReverseCharge

{
    "accountId": 13,
    "packageId": 18,
    "serviceId": 8,
    "amount": 20,
    "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": 26,
    "invoiceItemTypeId": 20,
    "baseAmount": 3,
    "invoiceAmount": 0,
    "invoiceCurrencyExchangeDetailId": 23,
    "originalInvoiceItemId": 5,
    "isManual": true,
    "createdByUserId": 1,
    "udrUsageIdentifier": "Sample Text Data",
    "accountServiceTemporalId": "Sample Text Data",
    "quantity": 27,
    "price": 23
}
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": 15,
                "packageName": "Sample Text Data",
                "serviceId": 5,
                "serviceName": "Sample Text Data",
                "amount": 27,
                "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": 7,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 25,
                "invoiceItemTypeName": "Sample Text Data",
                "baseAmount": 1,
                "invoiceAmount": 6,
                "invoiceCurrencyExchangeDetailId": 16,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 2,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 11,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data",
                "quantity": 19,
                "price": 15
            }
        ]
    }
}
POSTInvoice/Item/ReverseCredit
Create a new instance of the InvoiceItem object.
Create a new instance of the InvoiceItem object.
POST Invoice/Item/ReverseCredit

{
    "accountId": 18,
    "packageId": 12,
    "serviceId": 8,
    "amount": 8,
    "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": 2,
    "invoiceItemTypeId": 3,
    "baseAmount": 4,
    "invoiceAmount": 0,
    "invoiceCurrencyExchangeDetailId": 0,
    "originalInvoiceItemId": 18,
    "isManual": true,
    "createdByUserId": 8,
    "udrUsageIdentifier": "Sample Text Data",
    "accountServiceTemporalId": "Sample Text Data",
    "quantity": 22,
    "price": 16
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 17,
                "accountName": "Sample Text Data",
                "packageId": 19,
                "packageName": "Sample Text Data",
                "serviceId": 9,
                "serviceName": "Sample Text Data",
                "amount": 19,
                "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": 1,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 12,
                "invoiceItemTypeName": "Sample Text Data",
                "baseAmount": 15,
                "invoiceAmount": 11,
                "invoiceCurrencyExchangeDetailId": 8,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 11,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 10,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data",
                "quantity": 11,
                "price": 8
            }
        ]
    }
}
POSTInvoice/Item/TaxAdjustment
Create a new instance of the InvoiceItem object.
Create a new instance of the InvoiceItem object.
POST Invoice/Item/TaxAdjustment

{
    "accountId": 7,
    "packageId": 23,
    "serviceId": 15,
    "amount": 1,
    "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": 22,
    "invoiceItemTypeId": 3,
    "baseAmount": 1,
    "invoiceAmount": 17,
    "invoiceCurrencyExchangeDetailId": 16,
    "originalInvoiceItemId": 14,
    "isManual": true,
    "createdByUserId": 6,
    "udrUsageIdentifier": "Sample Text Data",
    "accountServiceTemporalId": "Sample Text Data",
    "quantity": 4,
    "price": 24
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 19,
                "accountName": "Sample Text Data",
                "packageId": 14,
                "packageName": "Sample Text Data",
                "serviceId": 13,
                "serviceName": "Sample Text Data",
                "amount": 21,
                "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": 9,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 14,
                "invoiceItemTypeName": "Sample Text Data",
                "baseAmount": 21,
                "invoiceAmount": 24,
                "invoiceCurrencyExchangeDetailId": 9,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 19,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 9,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data",
                "quantity": 25,
                "price": 19
            }
        ]
    }
}
PUTInvoice/Item/{id}
Update an existing instance of the InvoiceItem object.
Update an existing instance of the InvoiceItem object.
PUT Invoice/Item/{id}

{
    "identity": 1,
    "accountId": 27,
    "packageId": 13,
    "serviceId": 15,
    "amount": 15,
    "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": 3,
    "invoiceItemTypeId": 3,
    "baseAmount": 21,
    "invoiceAmount": 3,
    "invoiceCurrencyExchangeDetailId": 23,
    "originalInvoiceItemId": 1,
    "isManual": true,
    "createdByUserId": 5,
    "udrUsageIdentifier": "Sample Text Data",
    "accountServiceTemporalId": "Sample Text Data",
    "quantity": 24,
    "price": 4
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 11,
                "accountName": "Sample Text Data",
                "packageId": 17,
                "packageName": "Sample Text Data",
                "serviceId": 14,
                "serviceName": "Sample Text Data",
                "amount": 21,
                "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": 15,
                "invoiceName": "Sample Text Data",
                "invoiceItemTypeId": 12,
                "invoiceItemTypeName": "Sample Text Data",
                "baseAmount": 24,
                "invoiceAmount": 13,
                "invoiceCurrencyExchangeDetailId": 18,
                "invoiceCurrencyExchangeDetailName": "Sample Text Data",
                "originalInvoiceItemId": 25,
                "originalInvoiceItemName": "Sample Text Data",
                "isManual": true,
                "createdByUserId": 26,
                "createdByUserName": "Sample Text Data",
                "udrUsageIdentifier": "Sample Text Data",
                "accountServiceTemporalId": "Sample Text Data",
                "accountServiceTemporalName": "Sample Text Data",
                "quantity": 13,
                "price": 27
            }
        ]
    }
}