NAV

getCompany

GET /v2/company-partner/get

This call allows you to obtain information about the previously created company. Use this call if you would like to verify if a company account exists in SimplePin's database already with company_code created previously in your system. The call also returns API keys previously created for a particular company account.

Parameters
Name
Description
company_code string (required)

This parameters should be passed in your request in order to obtain information about the company.

Response Messages
Code
Description
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "address": {
        "id": 0,
        "zip": "string",
        "city": "string",
        "country": 0,
        "province": 0,
        "address": "string",
        "selected": true
    },
    "collect_taxes": true,
    "company_code": "string",
    "email": "string",
    "id": 0,
    "logo_url": "string",
    "name": "string",
    "phone": "string"
}
             
          
{ } CompanyResponseV2Model
address (optional) AddressApiV2Model
collect_taxes (optional) boolean
company_code (optional) string
email (optional) string
id (optional) integer
logo_url (optional) string
name (optional) string
phone (optional) string
{ } AddressApiV2Model
id (optional) integer
zip (optional) string
city (optional) string
country (optional) integer
province (optional) integer
address (optional) string
selected (optional) boolean
             <company_response_model>
  <address/>
  <collect_taxes>1</collect_taxes>
  <company_code>string</company_code>
  <email>string</email>
  <id>0</id>
  <logo_url>string</logo_url>
  <name>string</name>
  <phone>string</phone>
</company_response_model>

             
          
{ } CompanyResponseV2Model
address (optional) AddressApiV2Model
collect_taxes (optional) boolean
company_code (optional) string
email (optional) string
id (optional) integer
logo_url (optional) string
name (optional) string
phone (optional) string
{ } AddressApiV2Model
id (optional) integer
zip (optional) string
city (optional) string
country (optional) integer
province (optional) integer
address (optional) string
selected (optional) boolean