Clientes

—

Este endpoint visa gerir os clientes.

POST /customers/create

POST /customers/:id/update

POST /customers/:id/delete

POST /customers/find

POST /customers/list

POST /customers/:id/accounts_open

POST /customers/:id/accounts_open/download

POST /customers/:id/accounts_open/send_email

POST /customers/accounts_open

Clientes - Criar

O cliente é sempre criado no estado activo.

code string

Código do cliente. Se não for enviado nenhum valor vai ser dado seguimento ao último código ou gerado um código aleatório.

name string required

Nome

vat_number string

Contribuinte

country string

País

address string

Morada

city string

Localidade

postal_code string

Código postal

email string

telephone string

Telefone

mobile string

Telemóvel. Evite espaços e +351.

currency mixed

Moeda utilizada. Pode ser enviado o ID, símbolo ou descritivo, exemplo: €, $, Euro, Dólar. No caso de não preenchimento será assumido a moeda pré-definida.

payment_method mixed

Forma de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.

payment_condition mixed

Condição de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Pronto pagamento, 30 dias, etc.

shipping_mode mixed

Modo de expedição. Pode ser enviado o ID ou o descritivo, exemplo: Correios, Comboio, etc.

price mixed

Tabela de preços utilizada. Pode ser enviado o ID ou o descritivo, exemplo: Preços público, Preços revenda, etc.

employee mixed

Vendedor que adquiriu o cliente. Pode ser enviado o ID ou o email.

type string required

Tipo de cliente. Deve ser enviado um dos seguintes valores: Empresarial, Particular.

vat_type string required

Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.

vat_exemption mixed

Isenção de IVA a aplicar. Pode ser enviado o ID ou o código, exemplo: M08, etc. No caso de não preenchimento será assumido o valor M18 - Sem isenção.

irs_retention_tax double

Taxa de retenção na fonte

observations string

Observações do cliente

contact string

Outros contactos

other_emails string

Outros emails. Emails separados por vírgula.

receive_sms boolean

Determina se o cliente está apto a receber notificações de SMS despoletadas automaticamente

receive_emails boolean

Determina se o cliente está apto a receber notificações de Emails despoletadas automaticamente

language string

Determina o idioma por defeito no cliente. Deve ser enviado um dos seguintes valores: Auto, PT, EN. No caso de não preenchimento será assumido Auto.

addresses json array

Lista de moradas de entrega.

country string

País

address string

Morada

city string

Localidade

postal_code string

Código postal

Request POST /customers/create

{
    "code": ..
    "name": ..
    "vat_number": ..
    "country": ..
    "address": ..
    "city": ..
    "postal_code": ..
    "email": ..
    "telephone": ..
    "mobile": ..
    "currency": ..
    "payment_method": ..
    "payment_condition": ..
    "shipping_mode": ..
    "price": ..
    "employee": ..
    "type": ..
    "vat_exemption": ..
    "vat_type": ..
    "irs_retention_tax": ..
    "observations": ..
    "contact": ..
    "other_emails": ..
    "addresses": []
}

Response 200

{
    "status": true,
    "data": 
    {
        "id": ..
        "code": ..
        "name": ..
        "vat_number": ..
        "country": ..
        "address": ..
        "city": ..
        "postal_code": ..
        "email": ..
        "telephone": ..
        "mobile": ..
        "currency_id": ..
        "payment_method_id": ..
        "payment_condition_id": ..
        "shipping_mode_id": ..
        "price_id": ..
        "employee_id": ..
        "type": ..
        "vat_exemption_id": ..
        "vat_type": ..
        "irs_retention_tax": ..
        "observations": ..
        "contact": ..
        "other_emails": ..
        "code_blocked": ..
        "vat_number_blocked": ..
        "name_blocked": ..
        "active": ..
        "updated_at": ..
        "created_at": ..
        "addresses": []
        "currency": []
        "paymentmethod": []
        "paymentcondition": []
        "shippingmode": []
        "employee": []
        "price": []
        "vatexemption": []
    }
}

Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.

Não preencheu todos os campos obrigatórios
Não tem permissões para executar esta operação
É obrigatória a indicação de um valor para o campo X
O valor indicado para o campo código já se encontra registado
O contribuinte introduzido aparenta ser inválido para Portugal
O valor indicado para o campo Contribuinte já se encontra registado

Recibos - Lista Clientes - Actualizar

Introdução

Autenticação

Resposta e erros

SDKs e plugins

Países

Isenções IVA

Changelog

Vendas

Recibos

Clientes

Clientes - Contas em aberto

Artigos

Artigos - Stock

Artigos - Movimentos stock

Agenda - Marcações

Agenda - Indisponibilidades

Administração

Administração - Armazéns

Administração - Categorias

Administração - Colaboradores

Administração - Condições de pagamento

Administração - Formas de pagamento

Administração - Modos de expedição

Administração - Moedas

Administração - Preços

Administração - Séries

Administração - Taxas de IVA

Administração - Tipos de documento

Administração - Veículos

Administração - Unidades

Subscrição

Subscrição - Locais

Clientes

Clientes - Criar