GetInvoiceInfo (Pull Method)
GetInvoiceInfo
Retrieves detailed information about a specific invoice.
Supports both Normal and Supplement invoice types.
Request
| Parameter | Type | Description |
|---|---|---|
| InvoiceNumber | Varchar(50) | Required. Invoice Number to fetch. |
| Company | Varchar(250) | Optional. If not provided, invoices for all companies will be returned. |
| InvoiceType | Varchar(50) | Optional. Values: Normal, Supplement. Defaults to Normal. |
Response
| Parameter | Type | Description |
|---|---|---|
| InvoiceId | Int | Internal unique invoice ID. |
| UniqueId | Int | Unique ID per company. |
| InvoiceNumber | Varchar(50) | Invoice number. |
| Errors | Text Array | Contains error message(s) if an error occurs. |
| AssignmentType | Varchar(250) | Assignment type (CAT / Non‑CAT). |
| SupplementalRule | Bool | True/False for supplement rule. |
| AssignmentName | Varchar(250) | Name of the rule. |
| CATID | Varchar(50) | |
| Company | Varchar(250) | |
| InvoiceType | Varchar(50) | Returns “Normal” or “Supplement”. |
| VendorId | NVarchar(250) | |
| ClaimNumber | Varchar(50) | |
| TransactionId | Varchar(50) | Returned only for claims related to Xactimate. |
| Loss Street Address | Varchar(250) | |
| Loss City | Varchar(100) | |
| Loss State | Varchar(10) | |
| Loss Zipcode | Varchar(50) | |
| PolicyNumber | Varchar(50) | |
| InsuredName | Varchar(50) | |
| DateOfLoss | DateTime | |
| TypeOfLoss | Varchar(50) | |
| GrossEstimateAmount | Decimal | |
| PaOrAttorny | Varchar(50) | Possible values: Public Adjuster, Attorney, Other, None |
| FieldFee | Decimal | |
| PercentageFee | Decimal | |
| TaxesPercentage | Decimal | |
| TaxesAmount | Decimal | |
| InvoiceTotal (TotalAmount) | Decimal | |
| AdjusterName | Varchar(50) | |
| Status | Varchar(50) | Invoice status. |
| Comments | Text | |
| CreatedOn | DateTime | |
| ModifiedOn | DateTime | |
| CreatedBy | NVarchar(256) | Email of user who created the invoice. |
| ModifiedBy | NVarchar(256) | Email of user who modified the invoice. |
| Invoice Admin | NVarchar(50) | Related to Franchise model. May return: empty, User Account, or Username (email). |
| Creator User Account | NVarchar(50) | Internal user account ID for invoice creator. |
| Adjuster User Account | NVarchar(50) | Internal user account ID for adjuster. |
| Associated Adjuster | NVarchar(50) | Franchise‑related account association. |
| PendingReason | Varchar(500) | |
| ProcessingFees | Varchar(50) | |
| isManualInvoice | Bit | Indicates if invoice was created manually. |
Fields With Multiple Records
Unit of Measures (Array)
Each UOM entry contains:
- UnitOfMeasures
- FeePerUnit
- QuantityConsumed
- TotalCost
- FreeUnits
Flat Fees (Array)
Each entry contains:
- FlatFeeLabel
- FlatFeeAmount
Additional Expenses (Array)
Each entry contains:
- FieldName
- FieldAmount
- CommissionMethod
Fee Deductions (Array)
Each entry contains:
- FieldName
- FieldAmount
Example (C#)
// setup request parameters
NameValueCollection getInvoiceInfoParams = new NameValueCollection
{
{ "InvoiceNumber", "1317" },
{ "Company", "ABC"},
{ "InvoiceType", "Supplement" } // Normal or Supplement
};
dynamic getInvoiceInfoResponse = apiClient.GetInvoiceInfo(getInvoiceInfoParams);
Console.WriteLine("InvoiceInfo: {0}", getInvoiceInfoResponse);