Skip to content
More support
  • There are no suggestions because the search field is empty.

Pull Methods Overview & GetCompanies

Pull Methods Overview

Pull Methods allow third‑party systems to retrieve data from Invision.
All Pull Methods use the HTTP GET verb.

Available Pull Methods include:

  • GetCompanies — Retrieve the list of companies available to the API user
  • GetCompanyInfo — Retrieve details for a specific company
  • GetUsersInfo — Retrieve user information
  • GetClaimInfo — Retrieve claim details
  • GetInvoiceInfo — Retrieve invoice information
  • GetInvoicesByStatus — Retrieve invoices filtered by status
  • GetInvoicePDF — Retrieve invoice PDF and attached files
  • GetInvoiceDocuments — Retrieve all documents uploaded against an invoice
  • GetRules — Retrieve rules assigned to the company
  • GetReportInvoiceLineItems — Retrieve an invoice line item report
  • GetReportAccountsPayable — Retrieve an accounts payable report

The following sections provide full request/response specifications in the required format.

GetCompanies

Retrieves the list of companies the API credentials have access to.
This call is also used to obtain the Company value required by most other API methods.

Request
Parameter Type Description
Name Varchar(250) Optional. Returns only companies that start with the given phrase. If empty, all companies are returned.
Response
Parameter Type Description
Company Varchar(250) Company identifier in Invision. Required for all other API calls.
VendorId NVarchar(250) Vendor ID associated with the company.
Errors Text Array Contains error messages if an error occurs.
Example (C#)

 

// setup request parameters
NameValueCollection getCompaniesParams = new NameValueCollection
{
    { "Name", "ABC" } // or empty parameter { "Name", "" } to fetch all companies.
};

dynamic getCompaniesResponse = apiClient.GetCompanies(getCompaniesParams);

Console.WriteLine("GetCompanies:");
foreach (var item in getCompaniesResponse)
{
    Console.WriteLine("\t{0}", item.Company);
}

 

GetCompanyInfo

Retrieves details about a specific company returned from GetCompanies.

Request
Parameter Type Description
Company Varchar(250) Required. Company identifier from GetCompanies.
Response
Parameter Type Description
Company Varchar(250) Company identifier.
VendorId NVarchar(250) Vendor ID associated with this company.
Address Varchar(1000) Full company address.
City Varchar(50) City.
State Varchar(50) State.
Errors Text Array Contains error messages if an error occurs.
Example (C#)

 

// setup request parameters
NameValueCollection getCompanyInfoParams = new NameValueCollection
{
    { "Company", "ABC" }
};

dynamic getCompanyInfoResponse = apiClient.GetCompanyInfo(getCompanyInfoParams);

 

GetUsersInfo

Returns a list of users.

Request

This method does not take any request parameters.

Response
Parameter Type Description
Username Varchar(250) Email address of the user.
Name Varchar(250) First and last name.
Status Varchar(50) User status.
Role Varchar(50) User role.
UserAccount NVarchar(50) User account information.
Example (C#)

dynamic getUsersInfoResponse = apiClient.GetUsersInfo();

GetClaimInfo

Returns claim details for a given claim.

Request
Parameter Type Description
Company Varchar(250) Required. Company identifier from GetCompanies.
ClaimNumber Varchar(50) Required. Claim number from the estimating tool.
Response
Parameter Type Description
TransactionId Varchar(50)  
Errors Text Array Error messages if applicable.
ClaimNumber Varchar(50)  
PolicyNumber Varchar(50)  
InsuredFirstName Varchar(50)  
InsuredLastName Varchar(50)  
InsuredAddress Varchar(50)  
InsuredCity Varchar(50)  
InsuredState Varchar(50)  
InsuredZipCode Varchar(50)  
DateOfLoss Varchar(50)  
TypeOfLoss Varchar(50)  
GrossEstimateAmount Varchar(50)  
CarrierId Varchar(50)  
CarrierName Varchar(50)  
EstimateStatus Date  
CreatedOn Varchar(50)  
CATID Varchar(50)  
Example (C#)

 

// setup request parameters
NameValueCollection getClaimInfoParams = new NameValueCollection
{
    { "ClaimNumber", "6889" },
    { "Company", "ABC" }
};

dynamic getClaimInfoResponse = apiClient.GetClaimInfo(getClaimInfoParams);
Console.WriteLine("ClaimInfo:");
Console.WriteLine("\tClaimNumber : {0}", getClaimInfoResponse.GrossEstimateAmount);
Console.WriteLine("\tTransactionID : {0}", getClaimInfoResponse.EstimateStatus);