GET /receptors
Permite obtener la lista completa de clientes de una empresa

Permite obtener una lista de clientes de una empresa.

Formatos soportados

json

Errores

Code Description
200 Respuesta exitosa
401 No Autorizado
500 Servidor no disponible

Ejemplos

example...

POST /receptors
Permite crear un cliente de una empresa

Permite crear un cliente con la información enviada (Ver más abajo).

Formatos soportados

json

Errores

Code Description Metadata
401 Unauthorized
:status: status
:message: error_message
422 Unprocessable Entity
:status: status
:errors: []
500 Server crashed
:status: status
:message: error_message

Ejemplos

    === Ejemplo de los parametros que se deben de enviar con la petición para crear un cliente
{
	receptor: {
		name: 'string',
		social_reason: 'string',
		rfc: 'string',
		email: 'string',
		person_fiscal_type_id: 1,
		type_receptor_id: 1,
		country_id: 1
	},
	rfc_issuer: 'string'
}
    === Respuesta del servidor cuando el cliente se crea exitosamente, status: 201
{
  receptor: "RFC"
}
    === Respuesta del servidor cuando existe algun error, status: 422
{
  errors: ["error 1", "error 2"]
}

Parámetros

Nombre del parámetro Descripción
name
requerido

Nombre del cliente

Validations:

  • Must be String

social_reason
requerido

Razón social del cliente

Validations:

  • Must be String

rfc
requerido

RFC del cliente

Validations:

  • Must be String

email
opcional

Correo del cliente

Validations:

  • Must be String

person_fiscal_type_id
requerido

Tipo de persona fiscal

Validations:

  • Must be one of: 1, 2.


Metadata:
- 1: Persona Fisica
  2: Persona moral
type_receptor_id
requerido

Tipo de cliente

Validations:

  • Must be one of: 1, 2, 3.


Metadata:
- 1: Nacional
  2: Publico en general
  3: Extranjero
country_id
opcional

Id del pais(Consulte Servicio para obtener paises)

Validations:

  • Must be Integer

rfc_issuer
requerido

RFC de la empresa

Validations:

  • Must be String


GET /receptors/:id
Permite obtener la informacion de un cliente de una empresa

Permite obtener informacion de un cliente de una empresa filtrando por RFC.

Formatos soportados

json

Errores

Code Description
200 Respuesta exitosa
401 No Autorizado
404 No se encontro cliente
500 Servidor no disponible

Ejemplos

example...

PATCH /receptors/:id
Permite actualizar la informacion de un cliente asociado a una empresa

PUT /receptors/:id
Permite actualizar la informacion de un cliente asociado a una empresa

Permite actualizar la informacion de un cliente asociado a una empresa

Formatos soportados

json

Errores

Code Description
200 Respuesta exitosa
401 No Autorizado
404 No se encontro cliente
422 Registro no procesado
500 Servidor no disponible

Ejemplos

example...