Invoice Object
Click the links below to view the Invoice Object properties and an example.
Invoice Object Properties
id
integer
The record ID.
Example:
"id": "356981"
accountingUnit
integer (optional)
The accounting unit.
Example:
"accountingUnit": "2"
invDate
string (optional)
The invoice date and time as entered by the user, in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZZ).
Example:
"invDate": "2005-12-23T08:00:00Z"
invNum
string (optional)
The invoice number as entered by the user.
Example:
"invNum": "5122"
taxType
string (optional)
Indicates the tax information, if your library has enabled the feature to pay invoices using GST or VAT.
Example:
"taxType": "gst"
vendors
array
a list of vendor details for the invoice,
Example
"vendors": [
{
"vendorCode": "baboz"
"voucherNum": "53"
"voucherTotal": "6276"
}
]
Child Properties
vendorCode
string
The vendor code.
Example:
"vendorCode": "baboz"
voucherNumber
integer (optional)
The voucher number.
Example:
"voucherNumber": 53
voucherTotal
integer (optional)
The voucher total.
Example:
"voucherTotal": 6276
paidDate
string (optional)
The date and time that the invoice was paid, in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZZ),
Example:
"paidDate": "2007-09-18T07:00:00Z"
forCurrency
object (optional)
The invoice's foreign currency code, rate, and format,
Example
"forCurrency": {
"code": gbp
"rate": 1.6454
"format": ,.2bp
}
Child Properties
code
string (optional)
The currency code. Maximum length, three characters (no hyphens, periods, or numbers).
Example:
"code": "gbp"
rate
integer (optional)
The currency rate of exchange, that is, the value of the foreign currency in terms of your local currency. Maximum length: 11 characters (numbers and decimal point).
Example:
"rate": 1.6454
format
integer (optional)
The currency format. This field contains four elements:
Places Separator - a punctuation character that separates every three digits for nonfractional values in large numbers. For example, the commas in 1,000,000.
Fractional Separator - a punctuation character that separates fractional values. For example, the period in 12.95 to separate dollars from cents.
Precision - a number that specifies the number of decimal places in the currency. For example, 133.57 has two places of precision.
Symbol - the currency symbol. It can be a single character ($), a string (HK$), or a braced diacritic ({u00A3} for £ the British pound).
Example:
"format": ,.2bp
invTotal
object (optional)
The invoice totals.
Example
"invTotal": {
"subTotal": 204.08,
"shipping": 0,
"tax": 16.84,
"discountOrService": 0,
"grandTotal": 220.92
}
Child Properties
subTotal
number (optional)
The invoice subtotal.
Example:
"subtotal": "204.08"
shipping
number (optional)
The shipping change associated with the invoice.
Example:
"shipping": 0
tax
number (optional)
The tax associated with the invoice.
Example:
"tax": 16.84
discountOrService
number (optional)
The discount or service charges associated with the invoice.
Example:
"discountOrService": 0
grandTotal
number (optional)
The invoice total or subtotal, shipping charges, tax, and discount/service charges.
Example:
"grandTotal": 220.92
useTax
integer (optional)
The invoice use tax percentage rate and fund.
Example:
"useTax": {
"useTaxFund": "No use tax applies to this invoice."
"percentageRate": 7
}
Child Properties
useTaxFund
string (optional)
The fund from which use tax is paid if the vendor does not charge or undercharge sales tax, but you remain liable to pay the tax.
Example:
"useTaxFund": "No use tax applies to this invoice."
percentageRate
number (optional)
The shipping change associated with the invoice.
Example:
"percentageRate": 7
lineItems
array (optional)
A list of links to line item ids for the invoice
Example
"lineItems": {
"total": 2
"entries": [
{
"https://example-library.edu/iii/sierra-api/v6/invoices/lineItems/47"
"https://example-library.edu/iii/sierra-api/v6/invoices/lineItems/50"
}
]
}
Child Properties
total
integer (optional)
The total number of line item links associated with this invoice.
Example:
"total": 2
entries
array (optional)
An array of strings, where each string contains a link to a specific line item.
Example:
"entries": [
{
"https://example-library.edu/iii/sierra-api/v6/invoices/lineItems/47"
"https://example-library.edu/iii/sierra-api/v6/invoices/lineItems/50"
}
]
statusCode
string (optional)
The invoice status code.
Example:
"statusCode": "c"
Default Response Contents
The default query response for patron records includes these fields:
- id
- accountingUnit
- invNum
- invDate
- agencyCode
- paidDate
- forCurrency
- invTotals
- useTax
You must specify any other invoice data using filter parameters. For example:
https://<server-name>:443/iii/sierra-api/v6/invoices/?login=<Sierra-Login>&fields=id%2CtaxType
Returns the id and taxType data for invoices that the supplied Sierra login has permission to view.
When you use the fields parameter, the API returns only the ID and specified properties. You can specify the value "default" to retrieve all default properties in addition to any explicitly specified properties, such as lineItems. For example:
https://<server-name>:443/iii/sierra-api/v6/invoices/?login=<Sierra-Login>&fields=default%2ClineItems
Returns the default properties plus the lineItems field that the supplied Sierra login has permission to view.
Invoice Object Example
Example response for:
https://example-library.edu/iii/sierra-api/v6/invoices/?login=<Sierra username>&id=1050001{
"id": 1050001,
"entries": [
{
"id": 1000039,
"accountingUnit": 2,
"invDate": "2005-12-23T08:00:00Z",
"invNum": "5122",
"paidDate": "2006-01-18T08:00:00Z",
"invTotal": {
"subTotal": 204.08,
"shipping": 0,
"tax": 16.84,
"discountOrService": 0,
"grandTotal": 220.92
},
"useTax": {
"useTaxFund": "No use tax applies to this invoice",
"percentageRate": 0,
"useTaxType": "None"
}
]
}