The Invoice API
The Invoice API contains methods for retrieving invoice records and data. Invoice records contain data from the process of paying for materials in Acquisitions.
With the Invoice API, you can:
The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.
See also:
Get a List of Invoices
GET /v6/invoices/
Returns invoice data that the supplied Sierra login has permission to view (based on funds / accounting unit linked to the Sierra login). Records can be filtered by other fields, such as a list of invoice numbers or status or a range of invoice dates, including the invoice date used when the invoice is created, updated or deleted. Invoice records are filtered based on the records that the supplied Sierra login has permission to view.
You can filter the invoice data returned by:
| Item | Parameter | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| List of agency codes | agencyCodes | Returns invoice data for a comma delimited list of one or more valid agency codes that you supply | ||||||||||||||||||||
| Range of invoice dates | invNum | Returns invoice data for a comma delimited list of one or more valid invoice numbers that you supply. You can also use a wildcard * to represent one or more final characters. | ||||||||||||||||||||
| List of invoice status | statusCode | Returns invoice data for a comma delimited list of one or more valid status codes that you supply. Valid invoice status codes are:
|
Get a Line Item Record by Line ID
GET /v6/invoices/lineItems/{id}
Returns a list of invoices based on a supplied record ID.
Get a List of Metadata
GET /v6/invoices/metadata
Returns use tax metadata. If a language parameter is supplied and that language is configured in Sierra, data returned is in the supplied language; otherwise, data is returned in English.