Companies

Obter Empresa

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

200

OK

application/json

idstringOpcional

namestringOpcional

fiscal_registration_numberstringOpcional

address_typestringOpcional

streetstringOpcional

numberstringOpcional

complementstringOpcional

neighborhoodstringOpcional

citystringOpcional

statestringOpcional

countrystringOpcional

activebooleanOpcional

postal_codestringOpcional

404

Company was not found

application/json

500

An internal server error was thrown

application/json

get

/companies/{id}

HTTPcURLJavaScriptPython

GET /api/sales/companies/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Atualizar Empresa

put

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Corpo

application/json

namestringObrigatório

fiscal_registration_numberstringObrigatório

address_typestringObrigatório

streetstringObrigatório

numberstringObrigatório

complementstringObrigatório

neighborhoodstringObrigatório

citystringOpcional

statestringObrigatório

countrystringObrigatório

activebooleanObrigatório

postal_codestringObrigatório

Respostas

200

Company updated successfully

application/json

idstringOpcional

namestringOpcional

fiscal_registration_numberstringOpcional

address_typestringOpcional

streetstringOpcional

numberstringOpcional

complementstringOpcional

neighborhoodstringOpcional

citystringOpcional

statestringOpcional

countrystringOpcional

activebooleanOpcional

postal_codestringOpcional

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put

/companies/{id}

HTTPcURLJavaScriptPython

PUT /api/sales/companies/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Remover Empresa

delete

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

idstringObrigatório

Respostas

204

Company removed successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

delete

/companies/{id}

HTTPcURLJavaScriptPython

DELETE /api/sales/companies/{id} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text"
}

Listar Empresas

get

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: ""

dirstringOpcionalDefault: asc

Respostas

200

OK

application/json

idstringOpcional

namestringOpcional

fiscal_registration_numberstringOpcional

address_typestringOpcional

streetstringOpcional

numberstringOpcional

complementstringOpcional

neighborhoodstringOpcional

citystringOpcional

statestringOpcional

countrystringOpcional

activebooleanOpcional

postal_codestringOpcional

404

Company was not found

application/json

500

An internal server error was thrown

application/json

get

/companies

HTTPcURLJavaScriptPython

GET /api/sales/companies HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

Criar Empresa

post

Autorizações

authX-Zydon-Access-Key-TokenX-Zydon-Access-Key-Code

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

idstringOpcional

namestringObrigatório

fiscal_registration_numberstringObrigatório

address_typestringObrigatório

streetstringObrigatório

numberstringObrigatório

complementstringObrigatório

neighborhoodstringObrigatório

citystringObrigatório

statestringObrigatório

countrystringObrigatório

activebooleanObrigatório

postal_codestringObrigatório

Respostas

201

Company created successfully

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/companies

HTTPcURLJavaScriptPython

POST /api/sales/companies HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": "text",
  "name": "text",
  "fiscal_registration_number": "text",
  "address_type": "text",
  "street": "text",
  "number": "text",
  "complement": "text",
  "neighborhood": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "active": true,
  "postal_code": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}