companies resource

GET https://api.multinexo.comusers/{user_id}/companies

Attributes

name: create, read, update string
legal_name: create, read, update
status: read enum (activated, suspended, redeem, building)
abbreviation: create, read, update string
description: create, read, update string
cuit: create, read, update
activities_start_date: create, read, update
gross_income: create, read, update
email: create, read, update
seat_tim: create, read, update
establishment_number: create, read, update
department: create, read, update
province: create, read, update
logo_url: read
street_name: create, read, update string
street_number: create, read, update numeric
phone: create, read, update string
fiscal_ws_status: read enum (, waiting, ok)
started_at: read
expire_at: read
remaining_documents: read
csr_url: create, read, update
deleted_at: read
deleted: read DeletedFilter Sortable

Relationships

fiscalpos: has one of type: fiscalpos
user: has one of type: user
responsibility: has one of type: responsibility
company_payments: has one of type: company_payments
plan: has one of type: plan
notifications: has one of type: notifications

Filter example

https://api.multinexo.comusers/{user_id}/companies?filter[deleted]=someValue

JSON Resource Example

  {
    data: {
      type: companies,
      id: 547,
      attributes: {
        name: string,
        legal_name: someValue,
        status: someValue,
        abbreviation: string,
        description: string,
        cuit: someValue,
        activities_start_date: someValue,
        gross_income: someValue,
        email: someValue,
        seat_tim: someValue,
        establishment_number: someValue,
        department: someValue,
        province: someValue,
        logo_url: someValue,
        street_name: string,
        street_number: someValue,
        phone: string,
        fiscal_ws_status: someValue,
        started_at: someValue,
        expire_at: someValue,
        remaining_documents: someValue,
        csr_url: someValue,
        deleted_at: someValue,
        deleted: someValue
        },
      relationships: { 
         fiscalpos:{
          id: 919,
          type: fiscalpos
        },
      
         user:{
          id: 985,
          type: user
        },
      
         responsibility:{
          id: 421,
          type: responsibility
        },
      
         company_payments:{
          id: 678,
          type: company_payments
        },
      
         plan:{
          id: 832,
          type: plan
        },
      
         notifications:{
          id: 835,
          type: notifications
        }
      }
    }
  }

JSON-API Entry points

DELETE PATCH GET https://api.multinexo.comusers/{user_id}/companies/{resource_id}

POST https://api.multinexo.comusers/{user_id}/companies/

Special entry points

POST […]v1/users/{user_id}/companies/{company_id}/logo POST […]v1/users/{user_id}/companies/{company_id}/upload/crt DELETE […]v1/users/{user_id}/companies/{company_id}/logo/{nameImage} PATCH […]v1/users/{user_id}/companies/{company_id}/restore GET […]v1/users/{user_id}/companies/{company_id}/download/csr