GetReportInvoiceLineItems (Pull Method)
GetReportInvoiceLineItems
Generates an Invoice Line Items report for a company and date range.
The endpoint returns base64‑encoded bytes that you must decode and save as an .xls file to view the report columns.
Request
| Parameter | Type | Description |
|---|---|---|
| Company | Varchar(250) | Company identifier from GetCompanies. |
| StartDate | Date | Required. Start date of the range to include. |
| EndDate | Date | Required. End date of the range to include. |
| InvoiceStatus | Varchar(250) | Optional. Possible values include: Approved, Pending, Rejected, Active, Inactive, AwaitingPayment, Paid, ReadyforPayment. |
| Adjusters | Varchar(100) | Optional. Filter by adjuster(s). |
| AssignmentType | Varchar(50) | Optional. |
| AssignmentCategory | Varchar(250) | Optional. |
| LineItem | Varchar(250) | Optional. |
| LossType | Varchar(50) | Optional. |
| State | Varchar(50) | Optional. |
Response
Returns base64‑encoded bytes that, when decoded and written to an .xls file, contain rows with the following columns:
| Parameter | Type | Description |
|---|---|---|
| InvoiceId | Int | Internal unique identification of the invoice. |
| Company | Varchar(250) | Company name. |
| AdjusterName | Varchar(100) | Adjuster name. |
| InvoiceNumber | Varchar(50) | Invoice number. |
| ClaimNumber | Varchar(50) | Claim number. |
| LossType | Varchar(50) | Loss type. |
| State | Varchar(50) | Insured state. |
| Status | Varchar(50) | Invoice status. |
| AssignmentType | Varchar(50) | CAT / Non‑CAT, etc. |
| AssignmentName | Varchar(250) | Rule/assignment name. |
| LineItemName | Varchar(250) | Line item label. |
| FieldFee | Varchar(50) | Field fee amount. |
| PercentageFee | Varchar(50) | Percentage fee amount. |
| FlatFeeAmount | Varchar(50) | Flat fee amount. |
| Hours | Varchar(50) | Sample UOM column (depends on rule setup). |
| Mileage | Varchar(50) | Sample UOM column (depends on rule setup). |
| HourlyAmount | Varchar(50) | Sample UOM column (depends on rule setup). |
| HourlyConsumed | Varchar(50) | Sample UOM column (depends on rule setup). |
| MileageAmount | Varchar(50) | Sample UOM column (depends on rule setup). |
| MileageConsumed | Varchar(50) | Sample UOM column (depends on rule setup). |
| PhotosAmount | Varchar(50) | Sample UOM column (depends on rule setup). |
| PhotosConsumed | Varchar(50) | Sample UOM column (depends on rule setup). |
| Reinspection | Varchar(50) | Sample UOM column (depends on rule setup). |
| AdditionalExpenseAmount | Varchar(50) | Additional expenses total. |
| FeeDeduction | Varchar(50) | Fee deductions total. |
| TaxesPercentage | Varchar(50) | Tax percentage. |
| TaxesAmount | Varchar(50) | Tax amount. |
| ProcessingFee | Varchar(50) | Processing fee. |
| InvoiceAmount | Varchar(50) | Invoice total. |
| Estimate | Varchar(50) | Estimate value. |
| CreatedOn | Datetime | Created timestamp. |
| Errors | Text Array | Contains error message(s) if an error occurs. |
Example (C#)
// setup request parameters
NameValueCollection objReportInvoiceLineItemParams = new NameValueCollection
{
{ "Company", "ABC" },
{ "StartDate", "2019-07-24" },
{ "EndDate", "2019-07-24" },
{ "InvoiceStatus", "Payment Received" },
{ "Adjusters", "" },
{ "AssignmentType", "" },
{ "AssignmentCategory", "" },
{ "LineItem", "" },
{ "LossType", "" },
{ "State", "" }
};
dynamic getInvoiceLineItemsResponse = apiClient.GetReportInvoiceLineItems(objReportInvoiceLineItemParams);
// decode and save as .xls
byte[] lineItemBytes = Convert.FromBase64String(Convert.ToString(getInvoiceLineItemsResponse));
string reportFileName = $"LineItem-{DateTime.Now:MM-dd-yyyy HH-mm-ss}.xls";
File.WriteAllBytes(@"C:\DownloadAPIFiles\" + reportFileName, lineItemBytes);
Console.WriteLine("Saved file: {0}", reportFileName);