Clientes - Procurar
—
Este endpoint destina-se exclusivamente a consultas pontuais e esporádicas. Não deve ser utilizado para pesquisas contínuas, polling periódico
ou como mecanismo de listagem de dados. Para mais informações, leia a documentação da página
Propósito da API.
value
mixed
required
Valor a procurar
search_in
string
Determina em que campo deve ser procurado. Pode ser enviado um dos seguintes valores: ID, Code,
Name, Email, Vat Number, Mobile.
URL
https://facturalusa.pt/api/v2/customers/find
Método
post
Resposta
200
{
"id": integer,
"code": string,
"name": string,
"vat_number": string,
"country": string,
"address": string,
"city": string,
"postal_code": string,
"email": string,
"telephone": string,
"mobile": string,
"currency_id": integer,
"payment_method_id": integer,
"payment_condition_id": integer,
"shipping_mode_id": integer,
"price_id": integer,
"employee_id": integer,
"type": string,
"vat_exemption_id": integer,
"vat_type": string,
"irs_retention_tax": decimal,
"observations": string,
"other_contacts": string,
"other_emails": string,
"code_blocked": boolean,
"vat_number_blocked": boolean,
"name_blocked": boolean,
"receive_sms": boolean,
"receive_emails": boolean,
"language": string,
"active": boolean,
"updated_at": string,
"created_at": string,
"currency": {
"id": integer,
"description": string,
"symbol": string,
"code_iso": string,
"exchange_sale": decimal,
"is_default": boolean,
"active": boolean,
"updated_at": string,
"created_at": string
},
"paymentmethod": {
"id": integer,
"description": string,
"description_english": string,
"active": boolean,
"updated_at": string,
"created_at": string
},
"paymentcondition": {
"id": integer,
"description": string,
"description_english": string,
"days": integer,
"active": boolean,
"updated_at": string,
"created_at": string
},
"shippingmode": {
"id": integer,
"description": string,
"description_english": string,
"active": boolean,
"updated_at": string,
"created_at": string
},
"employee": {
"id": integer,
"name": string,
"address": string,
"city": string,
"postal_code": string,
"country": string,
"email": string,
"telephone": string,
"mobile": string,
"is_salesman": boolean,
"active": boolean,
"updated_at": string,
"created_at": string
},
"price": {
"id": integer,
"description": string,
"is_default": boolean,
"active": boolean,
"updated_at": string,
"created_at": string
},
"vatexemption": {
"id": integer,
"code": string,
"description": string
},
"addresses": [
{
"id": integer,
"customer_id": integer,
"address": string,
"city": string,
"postal_code": string,
"country": string,
"updated_at": string,
"created_at": string
}
]
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.