API Overview

Company API

Overview

The PaymentEvolution Company API allows partners to add, get and update companies within their group of companies  

URL	/api/v1/company/
Methods supported	GET, POST
Description	Get all companies, or Add new company

Elements (required)	Expected input	Description
AddressLine1	Alphanumeric
AddressLine2	Alphanumeric
City	Alphanumeric
Company	Alphanumeric	Company Name
Email	Alphanumeric
FirstName	Alphanumeric
LastName	Alphanumeric
PayrollAcccount	Alphanumeric	Follows Mod 10  – CRA Business number
Province	Alphanumeric
TelephoneAreaCode	Numerical digit – Length 3
TelephoneNumber	Numerical digit – Length 7

 Sample POST  

<Company>  
        <AddressLine1>test workplace4 st</AddressLine1>  
        <AddressLine2></AddressLine2>  
        <City>toronto</City>  
        <Company>Workplace7</Company>  
        <Country>Canada</Country>  
        <Email>workplace9@we.local</Email>  
        <FirstName>test</FirstName>  
        <LastName>test</LastName>  
        <PayrollAccount></PayrollAccount>  
        <PostalCode>L4W5A8</PostalCode>  
        <Province>ONTARIO</Province>  
        <TelephoneAreaCode>416</TelephoneAreaCode>         <TelephoneNumber>5556789</TelephoneNumber>  
    </Company>

Sample Response  

Company Model with <CompanyID> for future queries