TAG LINE
SMALL TITLE
Version 4 APIs
APIs based on the latest platform version 10.3.X
Version 3 APIs
APIs based on platform version 10.2.1
Version 2 APIs
APIs based on platform version 10.2.0

Invoice

(API Version v3)

This entity represents an Invoice on an Account with related details.

What can you do with Invoice?

Properties

Property Details
identity
READ-ONLY
"identity": 18
Type: Number
This is the unique numeric identifier for the Invoice
accountId
"accountId": 20
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.
name
"name": "Hello World"
Type: String
The system generated invoice identifier/number.
date
"date": "2021-04-26T15:25:27.587Z"
Type: Date
The Date Time stamp to appear on the Invoice.

Date and time values are specified in the ISO 8601 format.
sent
"sent": "2021-04-26T15:25:27.587Z"
Type: Date
The Date Time stamp for when this Invoice was sent to the Account Contact.

Date and time values are specified in the ISO 8601 format.
due
"due": "2021-04-26T15:25:27.587Z"
Type: Date
The Date Time for when this Invoice payment is due.

Date and time values are specified in the ISO 8601 format.
lastChecked
"lastChecked": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
invoiceStatusTypeId
"invoiceStatusTypeId": 12
Type: Number
Unique identifier for the associated InvoiceStatusType object.
invoiceStatusTypeName
"invoiceStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the invoiceStatusTypeId property.
processed
"processed": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
billRunHistoryId
"billRunHistoryId": 11
Type: Number
Unique identifier for the associated BillRunHistory object.
billRunHistoryName
"billRunHistoryName": "Sample Name"
Type: String
The name of the object associated with the billRunHistoryId property.
previousBalance
"previousBalance": 102.52
Type: Number
The balance of the Account that was carried forward.
balance
"balance": 202.52
Type: Number
The current outstanding balance of this Invoice.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
closed
"closed": "2021-04-26T15:25:27.587Z"
Type: Date
The Date Time stamp for when this Invoice was closed.

Date and time values are specified in the ISO 8601 format.
total
"total": 100.15
Type: Number
The grand total of the Invoice.
totalCharge
"totalCharge": 100.15
Type: Number
The total new charges for the Invoice.
totalTax
"totalTax": 12.15
Type: Number
The sum of all the taxes for the Invoice.
totalDiscount
"totalDiscount": 10.36
Type: Number
The sum of all the discounts for the Invoice.
totalPaymentApplied
"totalPaymentApplied": 12.36
Type: Number
The total amount of payment that has been disbursed to this Invoice.
totalCreditApplied
"totalCreditApplied": 11.36
Type: Number
The total amount of credits that have been disbursed to this Invoice.
totalPaymentAttached
"totalPaymentAttached": 7.36
Type: Number
The total amount of payment that should be shown on this Invoice.
totalCreditAttached
"totalCreditAttached": 5.34
Type: Number
The total amount of credits that should be shown on this Invoice.
baseTotal
"baseTotal": 100.15
Type: Number
The total of the Invoice converted to Owner/base currency.
baseTotalCharge
"baseTotalCharge": 100.15
Type: Number
The total new charges for the Invoice converted to Owner/base currency.
baseTotalDiscount
"baseTotalDiscount": 10.36
Type: Number
The sum of all the discounts for the Invoice converted to Owner/base currency.
baseTotalPaymentApplied
"baseTotalPaymentApplied": 12.36
Type: Number
The total amount of payment that has been disbursed to this Invoice converted to Owner/base currency.
baseTotalCreditApplied
"baseTotalCreditApplied": 11.36
Type: Number
The total amount of credits that have been disbursed to this Invoice converted to Owner/base currency.
baseTotalPaymentAttached
"baseTotalPaymentAttached": 7.36
Type: Number
The total amount of payment that should be shown on this Invoice converted to Owner/base currency.
baseTotalCreditAttached
"baseTotalCreditAttached": 5.34
Type: Number
The total amount of credits that should be shown on this Invoice converted to Owner/base currency.
baseBalance
"baseBalance": 5.34
Type: Number
The current outstanding balance of this Invoice converted to Owner/base currency.
baseTotalTax
"baseTotalTax": 12.15
Type: Number
The sum of all the taxes for the Invoice converted to Owner/base currency.
basePreviousBalance
"basePreviousBalance": 102.52
Type: Number
The balance of the Account that was carried forward converted to Owner/base currency.
isVoid
"isVoid": true
Type: Boolean
Whether or not this Invoice has been voided.
isVoiding
"isVoiding": true
Type: Boolean
Whether or not this Invoice is the newly generated Invoice that offsets a voided invoice.
doNotDeliver
"doNotDeliver": true
Type: Boolean

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:

  • accountId
  • name
  • date
  • sent
  • due
  • lastChecked
  • invoiceStatusTypeId
  • processed
  • billRunHistoryId
  • previousBalance
  • balance
  • created
  • closed
  • total
  • totalCharge
  • totalTax
  • totalDiscount
  • totalPaymentApplied
  • totalCreditApplied
  • totalPaymentAttached
  • totalCreditAttached
  • baseTotal
  • baseTotalCharge
  • baseTotalDiscount
  • baseTotalPaymentApplied
  • baseTotalCreditApplied
  • baseTotalPaymentAttached
  • baseTotalCreditAttached
  • baseBalance
  • baseTotalTax
  • basePreviousBalance
  • isVoid
  • isVoiding
  • doNotDeliver

End Points

GETapi/v3/Invoice/
Retrieve all of the Invoice objects.
Retrieve all of the Invoice objects.
GET api/v3/Invoice/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "accountId": 0,
            "accountName": "Sample Text Data",
            "name": "Sample Text Data",
            "date": "2021-04-26T15:25:27.587Z",
            "sent": "2021-04-26T15:25:27.587Z",
            "due": "2021-04-26T15:25:27.587Z",
            "lastChecked": "2021-04-26T15:25:27.587Z",
            "invoiceStatusTypeId": 23,
            "invoiceStatusTypeName": "Sample Text Data",
            "processed": "2021-04-26T15:25:27.587Z",
            "billRunHistoryId": 27,
            "billRunHistoryName": "Sample Text Data",
            "previousBalance": 102.52,
            "balance": 202.52,
            "created": "2021-04-26T15:25:27.587Z",
            "closed": "2021-04-26T15:25:27.587Z",
            "total": 100.15,
            "totalCharge": 100.15,
            "totalTax": 12.15,
            "totalDiscount": 10.36,
            "totalPaymentApplied": 12.36,
            "totalCreditApplied": 11.36,
            "totalPaymentAttached": 7.36,
            "totalCreditAttached": 5.34,
            "baseTotal": 100.15,
            "baseTotalCharge": 100.15,
            "baseTotalDiscount": 10.36,
            "baseTotalPaymentApplied": 12.36,
            "baseTotalCreditApplied": 11.36,
            "baseTotalPaymentAttached": 7.36,
            "baseTotalCreditAttached": 5.34,
            "baseBalance": 5.34,
            "baseTotalTax": 12.15,
            "basePreviousBalance": 102.52,
            "isVoid": true,
            "isVoiding": true,
            "doNotDeliver": true
        }
    ]
}
GETapi/v3/Invoice/AvailableTokens/ByTemplate/{id}
Retrieve an instance of the Invoice object by its ID.
{id}Unique identifier for the Invoice object.
Retrieve an instance of the Invoice object by its ID.
GET api/v3/Invoice/AvailableTokens/ByTemplate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 3,
        "accountName": "Sample Text Data",
        "name": "Sample Text Data",
        "date": "2021-04-26T15:25:27.587Z",
        "sent": "2021-04-26T15:25:27.587Z",
        "due": "2021-04-26T15:25:27.587Z",
        "lastChecked": "2021-04-26T15:25:27.587Z",
        "invoiceStatusTypeId": 14,
        "invoiceStatusTypeName": "Sample Text Data",
        "processed": "2021-04-26T15:25:27.587Z",
        "billRunHistoryId": 2,
        "billRunHistoryName": "Sample Text Data",
        "previousBalance": 102.52,
        "balance": 202.52,
        "created": "2021-04-26T15:25:27.587Z",
        "closed": "2021-04-26T15:25:27.587Z",
        "total": 100.15,
        "totalCharge": 100.15,
        "totalTax": 12.15,
        "totalDiscount": 10.36,
        "totalPaymentApplied": 12.36,
        "totalCreditApplied": 11.36,
        "totalPaymentAttached": 7.36,
        "totalCreditAttached": 5.34,
        "baseTotal": 100.15,
        "baseTotalCharge": 100.15,
        "baseTotalDiscount": 10.36,
        "baseTotalPaymentApplied": 12.36,
        "baseTotalCreditApplied": 11.36,
        "baseTotalPaymentAttached": 7.36,
        "baseTotalCreditAttached": 5.34,
        "baseBalance": 5.34,
        "baseTotalTax": 12.15,
        "basePreviousBalance": 102.52,
        "isVoid": true,
        "isVoiding": true,
        "doNotDeliver": true
    }
}
GETapi/v3/Invoice/Paged
Retrieve all of the Invoice 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 Invoice objects in a paged fashion.
GET api/v3/Invoice/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": 17,
                "accountName": "Sample Text Data",
                "name": "Sample Text Data",
                "date": "2021-04-26T15:25:27.587Z",
                "sent": "2021-04-26T15:25:27.587Z",
                "due": "2021-04-26T15:25:27.587Z",
                "lastChecked": "2021-04-26T15:25:27.587Z",
                "invoiceStatusTypeId": 18,
                "invoiceStatusTypeName": "Sample Text Data",
                "processed": "2021-04-26T15:25:27.587Z",
                "billRunHistoryId": 1,
                "billRunHistoryName": "Sample Text Data",
                "previousBalance": 102.52,
                "balance": 202.52,
                "created": "2021-04-26T15:25:27.587Z",
                "closed": "2021-04-26T15:25:27.587Z",
                "total": 100.15,
                "totalCharge": 100.15,
                "totalTax": 12.15,
                "totalDiscount": 10.36,
                "totalPaymentApplied": 12.36,
                "totalCreditApplied": 11.36,
                "totalPaymentAttached": 7.36,
                "totalCreditAttached": 5.34,
                "baseTotal": 100.15,
                "baseTotalCharge": 100.15,
                "baseTotalDiscount": 10.36,
                "baseTotalPaymentApplied": 12.36,
                "baseTotalCreditApplied": 11.36,
                "baseTotalPaymentAttached": 7.36,
                "baseTotalCreditAttached": 5.34,
                "baseBalance": 5.34,
                "baseTotalTax": 12.15,
                "basePreviousBalance": 102.52,
                "isVoid": true,
                "isVoiding": true,
                "doNotDeliver": true
            }
        ]
    }
}
GETapi/v3/Invoice/Paged/Detail
Retrieve all of the Invoice 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 Invoice objects in a paged fashion with all object details.
GET api/v3/Invoice/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": 6,
                "accountName": "Sample Text Data",
                "name": "Sample Text Data",
                "date": "2021-04-26T15:25:27.587Z",
                "sent": "2021-04-26T15:25:27.587Z",
                "due": "2021-04-26T15:25:27.587Z",
                "lastChecked": "2021-04-26T15:25:27.587Z",
                "invoiceStatusTypeId": 14,
                "invoiceStatusTypeName": "Sample Text Data",
                "processed": "2021-04-26T15:25:27.587Z",
                "billRunHistoryId": 4,
                "billRunHistoryName": "Sample Text Data",
                "previousBalance": 102.52,
                "balance": 202.52,
                "created": "2021-04-26T15:25:27.587Z",
                "closed": "2021-04-26T15:25:27.587Z",
                "total": 100.15,
                "totalCharge": 100.15,
                "totalTax": 12.15,
                "totalDiscount": 10.36,
                "totalPaymentApplied": 12.36,
                "totalCreditApplied": 11.36,
                "totalPaymentAttached": 7.36,
                "totalCreditAttached": 5.34,
                "baseTotal": 100.15,
                "baseTotalCharge": 100.15,
                "baseTotalDiscount": 10.36,
                "baseTotalPaymentApplied": 12.36,
                "baseTotalCreditApplied": 11.36,
                "baseTotalPaymentAttached": 7.36,
                "baseTotalCreditAttached": 5.34,
                "baseBalance": 5.34,
                "baseTotalTax": 12.15,
                "basePreviousBalance": 102.52,
                "isVoid": true,
                "isVoiding": true,
                "doNotDeliver": true,
                "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v3/Invoice/{id}
Retrieve an instance of the Invoice object by its ID.
{id}Unique identifier for the Invoice object.
Retrieve an instance of the Invoice object by its ID.
GET api/v3/Invoice/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 21,
        "accountName": "Sample Text Data",
        "name": "Sample Text Data",
        "date": "2021-04-26T15:25:27.587Z",
        "sent": "2021-04-26T15:25:27.587Z",
        "due": "2021-04-26T15:25:27.587Z",
        "lastChecked": "2021-04-26T15:25:27.587Z",
        "invoiceStatusTypeId": 5,
        "invoiceStatusTypeName": "Sample Text Data",
        "processed": "2021-04-26T15:25:27.587Z",
        "billRunHistoryId": 7,
        "billRunHistoryName": "Sample Text Data",
        "previousBalance": 102.52,
        "balance": 202.52,
        "created": "2021-04-26T15:25:27.587Z",
        "closed": "2021-04-26T15:25:27.587Z",
        "total": 100.15,
        "totalCharge": 100.15,
        "totalTax": 12.15,
        "totalDiscount": 10.36,
        "totalPaymentApplied": 12.36,
        "totalCreditApplied": 11.36,
        "totalPaymentAttached": 7.36,
        "totalCreditAttached": 5.34,
        "baseTotal": 100.15,
        "baseTotalCharge": 100.15,
        "baseTotalDiscount": 10.36,
        "baseTotalPaymentApplied": 12.36,
        "baseTotalCreditApplied": 11.36,
        "baseTotalPaymentAttached": 7.36,
        "baseTotalCreditAttached": 5.34,
        "baseBalance": 5.34,
        "baseTotalTax": 12.15,
        "basePreviousBalance": 102.52,
        "isVoid": true,
        "isVoiding": true,
        "doNotDeliver": true
    }
}
GETapi/v3/Invoice/{id}/Detail
Retrieve deep detail of the Invoice 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 Invoice object.
Retrieve deep detail of the Invoice object by its ID.
GET api/v3/Invoice/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "accountId": 2,
        "accountName": "Sample Text Data",
        "name": "Sample Text Data",
        "date": "2021-04-26T15:25:27.587Z",
        "sent": "2021-04-26T15:25:27.587Z",
        "due": "2021-04-26T15:25:27.587Z",
        "lastChecked": "2021-04-26T15:25:27.587Z",
        "invoiceStatusTypeId": 4,
        "invoiceStatusTypeName": "Sample Text Data",
        "processed": "2021-04-26T15:25:27.587Z",
        "billRunHistoryId": 7,
        "billRunHistoryName": "Sample Text Data",
        "previousBalance": 102.52,
        "balance": 202.52,
        "created": "2021-04-26T15:25:27.587Z",
        "closed": "2021-04-26T15:25:27.587Z",
        "total": 100.15,
        "totalCharge": 100.15,
        "totalTax": 12.15,
        "totalDiscount": 10.36,
        "totalPaymentApplied": 12.36,
        "totalCreditApplied": 11.36,
        "totalPaymentAttached": 7.36,
        "totalCreditAttached": 5.34,
        "baseTotal": 100.15,
        "baseTotalCharge": 100.15,
        "baseTotalDiscount": 10.36,
        "baseTotalPaymentApplied": 12.36,
        "baseTotalCreditApplied": 11.36,
        "baseTotalPaymentAttached": 7.36,
        "baseTotalCreditAttached": 5.34,
        "baseBalance": 5.34,
        "baseTotalTax": 12.15,
        "basePreviousBalance": 102.52,
        "isVoid": true,
        "isVoiding": true,
        "doNotDeliver": true,
        "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
                    }
                ]
            }
        }
    }
}
POSTapi/v3/Invoice/{id}/Void
Void the specified Invoice.
{id}Unique identifier for the Invoice object.
PUTapi/v3/Invoice/{id}
Update an existing instance of the Invoice object.
Update an existing instance of the Invoice object.
PUT api/v3/Invoice/{id}

{
    "identity": 1,
    "accountId": 25,
    "name": "Sample Text Data",
    "date": "2021-04-26T15:25:27.587Z",
    "sent": "2021-04-26T15:25:27.587Z",
    "due": "2021-04-26T15:25:27.587Z",
    "lastChecked": "2021-04-26T15:25:27.587Z",
    "invoiceStatusTypeId": 15,
    "processed": "2021-04-26T15:25:27.587Z",
    "billRunHistoryId": 22,
    "previousBalance": 102.52,
    "balance": 202.52,
    "closed": "2021-04-26T15:25:27.587Z",
    "total": 100.15,
    "totalCharge": 100.15,
    "totalTax": 12.15,
    "totalDiscount": 10.36,
    "totalPaymentApplied": 12.36,
    "totalCreditApplied": 11.36,
    "totalPaymentAttached": 7.36,
    "totalCreditAttached": 5.34,
    "baseTotal": 100.15,
    "baseTotalCharge": 100.15,
    "baseTotalDiscount": 10.36,
    "baseTotalPaymentApplied": 12.36,
    "baseTotalCreditApplied": 11.36,
    "baseTotalPaymentAttached": 7.36,
    "baseTotalCreditAttached": 5.34,
    "baseBalance": 5.34,
    "baseTotalTax": 12.15,
    "basePreviousBalance": 102.52,
    "isVoid": true,
    "isVoiding": true,
    "doNotDeliver": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "accountId": 9,
                "accountName": "Sample Text Data",
                "name": "Sample Text Data",
                "date": "2021-04-26T15:25:27.587Z",
                "sent": "2021-04-26T15:25:27.587Z",
                "due": "2021-04-26T15:25:27.587Z",
                "lastChecked": "2021-04-26T15:25:27.587Z",
                "invoiceStatusTypeId": 19,
                "invoiceStatusTypeName": "Sample Text Data",
                "processed": "2021-04-26T15:25:27.587Z",
                "billRunHistoryId": 18,
                "billRunHistoryName": "Sample Text Data",
                "previousBalance": 102.52,
                "balance": 202.52,
                "created": "2021-04-26T15:25:27.587Z",
                "closed": "2021-04-26T15:25:27.587Z",
                "total": 100.15,
                "totalCharge": 100.15,
                "totalTax": 12.15,
                "totalDiscount": 10.36,
                "totalPaymentApplied": 12.36,
                "totalCreditApplied": 11.36,
                "totalPaymentAttached": 7.36,
                "totalCreditAttached": 5.34,
                "baseTotal": 100.15,
                "baseTotalCharge": 100.15,
                "baseTotalDiscount": 10.36,
                "baseTotalPaymentApplied": 12.36,
                "baseTotalCreditApplied": 11.36,
                "baseTotalPaymentAttached": 7.36,
                "baseTotalCreditAttached": 5.34,
                "baseBalance": 5.34,
                "baseTotalTax": 12.15,
                "basePreviousBalance": 102.52,
                "isVoid": true,
                "isVoiding": true,
                "doNotDeliver": true
            }
        ]
    }
}