entities resource

GET https://api.multinexo.comcompanies/{company_id}/entities

Attributes

contact_name: create, read, update string
street_name: create, read, update string
street_number: create, read, update numeric
location: create, read, update
province: create, read, update
additional_info: create, read, update
email: create, read, update
phone: create, read, update
observations: create, read, update
balance: read
balance_at: read
latitude: create, read, update
longitude: create, read, update
has_account: create, read, update
pdf_url: read
identification_id: create, read, update integer
responsibility_id: create, read, update integer
name: create, read, update string StringFilter Sortable
entity_type: create, read, update enum (client, supplier, employee, creditor, subdist, prevent) EnumFilter Sortable
identification_number: create, read, update StringFilter Sortable
deleted: read DeletedFilter Sortable
pareto_class: read EnumFilter Sortable
pareto_percent: read NumberFilter Sortable

Relationships

transactions: has one of type: transactions
documents: has one of type: documents
orders: has one of type: orders
invoices: has one of type: invoices
responsibility: has one of type: responsibility
pricelist: has one of type: pricelist
author: has one of type: author
identification: has one of type: identification
products: has one of type: products
seller: has one of type: seller
recommended_products: has one of type: recommended_products

Filter example

https://api.multinexo.comcompanies/{company_id}/entities?filter[name]=string

JSON Resource Example

  {
    data: {
      type: entities,
      id: 633,
      attributes: {
        contact_name: string,
        street_name: string,
        street_number: someValue,
        location: someValue,
        province: someValue,
        additional_info: someValue,
        email: someValue,
        phone: someValue,
        observations: someValue,
        balance: someValue,
        balance_at: someValue,
        latitude: someValue,
        longitude: someValue,
        has_account: someValue,
        pdf_url: someValue,
        identification_id: someValue,
        responsibility_id: someValue,
        name: string,
        entity_type: someValue,
        identification_number: someValue,
        deleted: someValue,
        pareto_class: someValue,
        pareto_percent: someValue
        },
      relationships: { 
         transactions:{
          id: 323,
          type: transactions
        },
      
         documents:{
          id: 955,
          type: documents
        },
      
         orders:{
          id: 877,
          type: orders
        },
      
         invoices:{
          id: 835,
          type: invoices
        },
      
         responsibility:{
          id: 711,
          type: responsibility
        },
      
         pricelist:{
          id: 292,
          type: pricelist
        },
      
         author:{
          id: 748,
          type: author
        },
      
         identification:{
          id: 441,
          type: identification
        },
      
         products:{
          id: 153,
          type: products
        },
      
         seller:{
          id: 574,
          type: seller
        },
      
         recommended_products:{
          id: 777,
          type: recommended_products
        }
      }
    }
  }

JSON-API Entry points

DELETE PATCH GET https://api.multinexo.comcompanies/{company_id}/entities/{resource_id}

POST https://api.multinexo.comcompanies/{company_id}/entities/