Invoice

What can you do with Invoice?


Properties

Property Details
id
"id": 715
Type: Number
This is the unique numeric identifier for the Invoice
accountId
"accountId": 756
Type: Number
Unique identifier for the associated Account object.
name
"name": "Hello World"
Type: String
date
"date": "2005-04-11T14:56:24"
Type: Date
sent
"sent": "2005-04-11T14:56:24"
Type: Date
due
"due": "2005-04-11T14:56:24"
Type: Date
lastChecked
"lastChecked": "2005-04-11T14:56:24"
Type: Date
invoiceStatusTypeId
"invoiceStatusTypeId": 914
Type: Number
Unique identifier for the associated InvoiceStatusType object.
processed
"processed": "2005-04-11T14:56:24"
Type: Date
billRunHistoryId
"billRunHistoryId": 570
Type: Number
Unique identifier for the associated BillRunHistory object.
previousBalance
"previousBalance": "Hello World"
Type: String
balance
"balance": "Hello World"
Type: String
created
"created": "2005-04-11T14:56:24"
Type: Date
closed
"closed": "2005-04-11T14:56:24"
Type: Date
total
"total": "Hello World"
Type: String
totalCharge
"totalCharge": "Hello World"
Type: String
totalTax
"totalTax": "Hello World"
Type: String
totalDiscount
"totalDiscount": "Hello World"
Type: String
totalPaymentApplied
"totalPaymentApplied": "Hello World"
Type: String
totalCreditApplied
"totalCreditApplied": "Hello World"
Type: String
totalPaymentAttached
"totalPaymentAttached": "Hello World"
Type: String
totalCreditAttached
"totalCreditAttached": "Hello World"
Type: String
baseTotal
"baseTotal": "Hello World"
Type: String
baseTotalCharge
"baseTotalCharge": "Hello World"
Type: String
baseTotalDiscount
"baseTotalDiscount": "Hello World"
Type: String
baseTotalPaymentApplied
"baseTotalPaymentApplied": "Hello World"
Type: String
baseTotalCreditApplied
"baseTotalCreditApplied": "Hello World"
Type: String
baseTotalPaymentAttached
"baseTotalPaymentAttached": "Hello World"
Type: String
baseTotalCreditAttached
"baseTotalCreditAttached": "Hello World"
Type: String
baseBalance
"baseBalance": "Hello World"
Type: String
baseTotalTax
"baseTotalTax": "Hello World"
Type: String
basePreviousBalance
"basePreviousBalance": "Hello World"
Type: String


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
  • 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

DataFlow PATCH objects:


End Points

GETapi/v1/Invoice
Retrieve all of the Invoice objects.
GETapi/v1/Invoice/Metadata
Retrieve all of the meta data details of the Invoice object.
GETapi/v1/Invoice/Metadata/{option}
Retrieve all the meta data details of the Invoice object based on provided options.
{option}Metadata options for the Invoice object.
GETapi/v1/Invoice/Paged
Retreive all of the Invoice objects in a paged fashion.
GETapi/v1/Invoice/Paged/Detail
Retreive all of the Invoice objects in a paged fashion with all object details.
GETapi/v1/Invoice/{id:int}
Retrieve an instance of the Invoice object by it's ID.
{id:int}Unique identifier for the Invoice object.
GETapi/v1/Invoice/{id:int}/Detail
Retreive all of the Detail objects for the specified Invoice.
{id:int}Unique identifier for the Invoice object.
GETapi/v1/Invoice/{id:int}/Render
Retreive all of the Render objects for the specified Invoice.
{id:int}Unique identifier for the Invoice object.
PUTapi/v1/Invoice/{id:int}
Update an existing instance of the Invoice object.