Get
Método utilizado para obtener los datos de un proveedor
Para consultar los datos de un proveedor podemos generar la siguiente solicitud con el archivo payload.json
:
curl "https://agents.boolfy.com/api/suppliers/get" \
-H "Authorization: Bearer BOOLFY_BEARER_KEY" \
-H "Content-Type: application/json" \
-d @payload.json
El archivo payload.json
debe tener el siguiente formato:
{
"TaxCode": "30123456780"
}
Detallamos en forma completa los campos de la solicitud:
TaxCode
Especifica el identificador fiscal del proveedor en el país que estas trabajando. Algunos de estos pueden ser: CUIT, CUIL, RFC y/o CNPJ entre otros.
Respuesta
La respuesta exitosa para la consulta de datos del documentos es:
{
"code": 200,
"msg": null,
"response": "[{\"Name\":\"Empresa SRL",\"TaxCode\":\"30123456780\"...}]"
}
Detallamos el contenido del campo Response:
Name
Especifica el nombre o razon social del proveedor
Brand
Especifica el nombre de fantasía o marca comercial del proveedor
Country
Especifica el país de origen del proveedor
TaxType
Especifica el tipo de inscripción del proveedor
TaxCode
Especifica el identificador fiscal del país de origen del proveedor
VatType
Especifica el tipo de inscripción frente a impuestos del proveedor.
ExternalCode
Especifica el identificador en tu plataforma del proveedor
Especifica el email del proveedor
Phone
Especifica el teléfono del proveedor
Notes
Especifica las notas que tiene adheridas el proveedor
State
Especifica el estado del proveedor. Ver Estados de revisión
Addresses
Especifica el listado de direcciones del proveedor. Ver Address
Address
Detallamos el contenido de las direcciones:
Name
Es el nombre del domicilio
Country
Especifica el país del domicilio
State
Especifica el estado o provincia del domicilio
City
Especifica la ciudad del domicilio
Street
Especifica el nombre de la calle o avenida del domicilio
Number
Especifica la altura o número de puerta del domicilio
Floor
En caso de existir, especifica el piso del domicilio
Department
En caso de existir, especifica el departamento del domicilio
Tower
En caso de existir, especifica la torre del domicilio
ZipCode
Especifica el código postal del domicilio
Última actualización