A nossa API é desenvolvida em formato REST, disponibilizamos URL's intuítivos e respostas em formato JSON. Pode experimentar e utilizar a API em modo demo enquanto constroi a sua aplicação. A API key determina se os pedidos efectuados são em ambiente produção ou teste.
Todos os pedidos devem ser feitos com recurso ao método POST.
Alguns valores decimais retornados pela API podem apresentar várias casas decimais, pelo que deve arredondar sempre que necessário a 2 casas decimais.
O Facturalusa utiliza uma API key para autenticar os pedidos. Esta API única pode ser visualizada no backoffice. Todos os pedidos devem enviar o parâmetro
api_token. Pedidos que não sejam feitos em HTTPS ou que não conste autenticação adequada vão dar erro.
Cada plano aplica uma restrição ao limite de pedidos que podem ser realizados num espaço de 24h:
Certifique-se que se mantêm abaixo deste valor para não ser bloqueado.
curl --request POST
--url 'https://facturalusa.pt/api/v1/sample'
--header 'Accept: application/json'
--header 'Content-type: application/json'
--body '{"api_token": "value", "param1": "value1"}'
Utilizámos os códigos de erros convencionais que indicam se o pedido foi feito ou não com sucesso, mas por norma apenas dois códigos são utilizados: 200 e 403,
que indicam, respectivamente, se o pedido foi feito com sucesso ou se foi recusado (por não ter permissões de acesso, por exemplo).
Também podem ser retornados outros códigos de erro, como por exemplo 4xx e 5xx, mas estes são menos comuns por se tratarem de erros internos. Em caso de anomalia por favor contacte-nos.
Em todas as situações a resposta é sempre devolvida em formato JSON e pode variar consoante seja bem sucedido e mal sucedido.
Em caso de erro:
HTTP 403 { status: false, message: ... }
Em caso de sucesso:
HTTP 200 { status: true }
Em caso de sucesso e com devolução de informação:
HTTP 200 { status: true, data: [] }
HTTP 200 { status: true, id: .. }
Caso o plano se encontre expirado, não é possível utilizar a API, sendo sempre devolvido o código 403.
| 200 - OK | Pedido executado com sucesso |
| 400 - Bad Request | Pedido incorrecto, talvez por falta de parâmetros |
| 401 - Unauthorized | A API key disponibilizada não é válida |
| 403 - Forbidden | A API key não tem permissões para efectuar o pedido ou parâmetros mal preenchidos |
| 404 - Not Found | O endpoint utilizado não se encontra disponível |
| 429 - Too Many Requests | Ultrapassou o limite de pedidos que pode fazer |
| 500, 502, 503, 504 - Server Errors | Erros internos da aplicação |
Disponibilizamos uma biblioteca em PHP para ajudar na interacção com a API e que pode ser instalada utilizando o Composer.
A documentação da biblioteca pode ser vista no repositório de GitHub https://github.com/Infolusa/php-facturalusa
// Instalação
$ composer require infolusa/php-facturalusa
// Utilização
$facturalusa = new \Facturalusa\FacturalusaClient('api_token');
$customer = new \Facturalusa\Customer\Customer($facturalusa);
$customer->list();
// Resposta
print_r($facturalusa->response());
Quando necessário preencher o campo country em determinados endpoints, este deve conter o nome do país em idioma inglês ou o código ISO universal.
Quando necessário preencher o campo vat_exemption em determinados endpoints, este deve conter o ID (1, 2, 3, ..) ou o código (M01, M02, M03, ..) da isenção de IVA.
attachments nos endpoints de envio de email das Vendas (sales/:id/send_email) e Recibos (receipts/:id/send_email), e que permite adicionar 2 anexos adicionais.Guia de movimentação de activos próprios.language nos clientes, que determina o idioma preferencial.waybill_global nos endpoints das Vendas em que determina se uma guia de transporte ou remessa é de teor global.communicate & communicate_documents_types na criação da série para possibilitar a imediata comunicação da série à AT, para obtenção do ATCUD.administration/documentstypes/:id/:serie_id/communicate que permite comunicar séries, para obtenção do ATCUD, após ter criado a série.country com o código ISO universal relativo ao país.sales/:id/receipt que permite rapidamente criar um Recibo de Cliente baseado numa Factura FT.avoid_sending_automatic_email dos endpoints das Vendas & Recibos.avoid_sending_automatic_sms dos endpoints das Vendas & Recibos.force_print nos endpoints das Vendas & Recibos.force_email nos endpoints das Vendas & Recibos.force_sms nos endpoints das Vendas & Recibos.force_sign nos endpoints das Vendas & Recibos./sign nas Vendas & Recibos que permite assinar digitalmente documentos.Removido a necessidade de introdução do tipo type da série. A criação das séries passa a ser assumido sempre como tipo Normal.
Este endpoint visa gerir a emissão de qualquer documento de venda: Facturas, Orçamentos, Encomendas e Guias. Os resultados retornados são os mesmos para qualquer um dos endpoints disponibilizados independentemente do tipo de documento emitido.
A emissão de documentos contabilísticos está dependente do volume de facturação do plano adquirido.
POST /sales/create |
POST /sales/:id/update |
POST /sales/:id/delete |
POST /sales/:id/cancel |
POST /sales/:id/duplicate |
POST /sales/:id/receipt |
POST /sales/:id/credit_note |
POST /sales/:id/debit_note |
POST /sales/:id/receipt |
POST /sales/:id/download |
POST /sales/:id/send_email |
POST /sales/:id/send_sms |
POST /sales/:id/generate_mbref |
POST /sales/:id/sign |
POST /sales/summary |
POST /sales/find |
POST /sales/list |
ID da venda a ser referenciada. Apenas deve ser preenchido quando o documento a ser emitido se trata de uma Nota de crédito ou Nota de débito e há uma referência a uma Factura, Factura Simplificada ou Factura Recibo.
Data de emissão do documento
Data de vencimento do documento
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Factura, Factura Recibo, Factura Simplificada, Nota de Crédito, Nota de Débito, Factura Pró-forma, Orçamento, Encomenda, Guia de Transporte, Guia de Remessa, Guia de Consignação, Guia de Devolução, Guia de movimentação de activos próprios.
Série. Pode ser enviado o ID ou o descritivo, exemplo: 2021, 2021A, etc. No caso de não preenchimento será assumido a série pré-definida.
Desconto financeiro €
Desconto global %
ID do cliente
Contribuinte do cliente. No caso de não preenchimento será assumido o valor 999999990.
Morada do cliente
Localidade do cliente
Código postal do cliente
País do cliente
Morada de entrega
Localidade da morada de entrega
Código postal da morada de entrega
País da morada de entrega
Método de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.
Condição de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Pronto pagamento, 30 dias, etc.
Modo de expedição. Pode ser enviado o ID ou o descritivo, exemplo: Correios, Comboio, etc.
Custo unitário da despesa de transporte
Taxa de IVA da despesa de transporte. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
Tabela de preços utilizada. Pode ser enviado o ID ou o descritivo, exemplo: Preços público, Preços revenda, etc. No caso de não preenchimento será assumido a tabela de preços pré-definida.
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.
Câmbio da moeda. Caso não seja enviado será assumido 1.
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
Observações do documento
Taxa de retenção na fonte
Veículo utilizado. Este campo apenas deve ser utilizado quando o tipo de documento emitido se trata de uma guia. Pode ser enviado o ID, matrícula ou nome.
Vendedor do documento. Pode ser enviado o ID ou o email.
Data de início de transporte da guia.
Determina se a guia se trata de uma guia global de transporte. Esta opção só pode ser utilizada se o documento a emitir se tratar de uma Guia de Transporte ou
Guia de Remessa. Se activo, os campos:
customer,
vat_number,
address,
city,
postal_code,
country,
delivery_address_address,
delivery_address_city,
delivery_address_postal_code,
delivery_address_country,
discharge_location e
location_destiny deixam de ter a obrigatoriedade de preenchimento e serão sempre automaticamente preenchidos pelo Facturalusa com as informações do cliente genérico.
Local de origem. Pode ser enviado o ID ou nome do local. No caso de não preenchimento será assumido o local de origem pré-definido.
Local de destino. Pode ser enviado o ID ou nome do local. Não será assumido nenhum valor se não for enviado nada.
Localidade de carga
Localidade de descarga
Data de carga
Data de descarga (prevista)
Lista de artigos que constam no documento.
ID ou referência do artigo
Descrição adicional a aparecer no documento
Preço unitário
Quantidade
Desconto percentual
Taxa de IVA a aplicar. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
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.
Idioma a ser impresso caso o estado do documento seja Terminado. Preencher com PT ou EN. No caso de não preenchimento será assumido o idioma pré-definido.
Formato a ser impresso caso o estado do documento seja Terminado. Preencher com A4 ou POS. No caso de não preenchimento será assumido o valor definido no tipo de documento (que por norma é A4).
Tamanho / largura do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à esquerda do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à direita do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em cima do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em baixo do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Determina se deve ou não gerar a impressão do documento caso o estado do mesmo seja Terminado. Se preenchido com true o documento será impresso; se preenchido com false o documento não será impresso; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar via email o documento para o cliente caso o estado do mesmo seja Terminado. Se preenchido com true o documento será enviado; se preenchido com false o documento não será enviado; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar SMS para o cliente caso o estado do documento seja Terminado. Se preenchido com true a SMS será enviada; se preenchido com false a SMS não será enviada; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver SMS disponíveis.
Determina se deve ou não assinar o documento caso o estado do documento seja Terminado e caso o mesmo seja impresso. Se preenchido com true o documento será assinado; se preenchido com false o documento não será assinado; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver a Assinatura Digital activada e bem configurada.
Estado do documento. Deve ser enviado um dos seguintes valores: Rascunho ou Terminado.
{
"sale_reference_id": ..,
"issue_date": ..
"due_date": ..
...
"items":
[
{
"id": ..,
"details": ..
"price": ..
"quantity": ..
"discount": ..
"vat": ..
"vat_exemption": ..
}
],
}{
"status": true,
"data":
{
"id": ..,
"number": ..,
"issue_date": ..,
"due_date": ..,
"serie_id": ..,
"document_type_id": ..,
"gross_total": ..,
"total_discount": ..,
"net_total": ..,
"total_base_vat": ..,
"total_vat": ..,
"total_shipping": ..,
"total_services": ..,
"grand_total": ..,
"final_discount_financial": ..,
"final_discount_global": ..,
"final_discount_value": ..,
"customer_id": ..,
"customer_code": ..,
"customer_name": ..,
"customer_vat_number": ..,
"customer_country": ..,
"customer_city": ..,
"customer_address": ..,
"customer_postal_code": ..,
"customer_delivery_address_country": ..,
"customer_delivery_address_address": ..,
"customer_delivery_address_city": ..,
"customer_delivery_address_postal_code": ..,
"company_name": ..,
"company_vat_number": ..,
"company_country": ..,
"company_address": ..,
"company_city": ..,
"company_postal_code": ..,
"company_vat_scheme": ..,
"payment_method_id": ..,
"payment_condition_id": ..,
"shipping_mode_id": ..,
"shipping_value": ..,
"shipping_vat_id": ..,
"price_id": ..,
"currency_id": ..,
"currency_exchange": ..,
"vehicle_id": ..,
"employee_id": ..,
"waybill_shipping_date": ..,
"waybill_global": ..,
"location_origin_id": ..,
"location_origin_name": ..,
"location_origin_country": ..,
"location_origin_address": ..,
"location_origin_city": ..,
"location_origin_postal_code": ..,
"warehouse_origin_id": ..,
"warehouse_destiny_id": ..,
"location_destiny_id": ..,
"cargo_location": ..,
"discharge_location": ..,
"cargo_date": ..,
"discharge_date": ..,
"mb_entity": ..,
"mb_sub_entity": ..,
"mb_reference": ..,
"at_code": ..,
"at_message": ..,
"vat_type": ..,
"observations": ..,
"irs_retention_apply": ..,
"irs_retention_base": ..,
"irs_retention_total": ..,
"irs_retention_tax": ..,
"url_file": ..,
"file_previewed": ..,
"file_last_generated": ..,
"status": ..,
"status_last_change": ..,
"created_by": ..,
"finished_by": ..,
"canceled_by": ..,
"canceled_at": ..,
"canceled_reason": ..,
"updated_at": ..,
"created_at": ..,
"reference": [],
"serie": [],
"documenttype": [],
"documenttypeserie": [],
"paymentmethod": [],
"paymentcondition": [],
"shippingmode": [],
"shippingvat": [],
"price": [],
"currency": [],
"vehicle": [],
"employee": [],
"locationdestiny": [],
"warehouseorigin": [],
"warehousedestiny": [],
"vats": [],
"items": [],
"createdby": [],
"finishedby": [],
"canceledby": [],
"customercountry": [],
"accountopen": [],
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Apenas pode ser utilizado caso o documento se encontre em rascunho.
ID da venda a ser referenciada. Apenas deve ser preenchido quando o documento a ser emitido se trata de uma Nota de crédito ou Nota de débito e há uma referência a uma Factura, Factura Simplificada ou Factura Recibo.
Data de emissão do documento
Data de vencimento do documento
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Factura, Factura Recibo, Factura Simplificada, Nota de Crédito, Nota de Débito, Factura Pró-forma, Orçamento, Encomenda, Guia de Transporte, Guia de Remessa, Guia de Consignação, Guia de Devolução, Guia de movimentação de activos próprios.
Série. Pode ser enviado o ID ou o descritivo, exemplo: 2021, 2021A, etc. No caso de não preenchimento será assumido a série pré-definida.
Desconto financeiro €
Desconto global %
ID do cliente
Contribuinte do cliente. No caso de não preenchimento será assumido o valor 999999990.
Morada do cliente
Localidade do cliente
Código postal do cliente
País do cliente
Morada de entrega
Localidade da morada de entrega
Código postal da morada de entrega
País da morada de entrega
Método de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.
Condição de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Pronto pagamento, 30 dias, etc.
Modo de expedição. Pode ser enviado o ID ou o descritivo, exemplo: Correios, Comboio, etc.
Custo unitário da despesa de transporte
Taxa de IVA da despesa de transporte. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
Tabela de preços utilizada. Pode ser enviado o ID ou o descritivo, exemplo: Preços público, Preços revenda, etc.
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.
Câmbio da moeda. Caso não seja enviado será assumido 1.
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
Observações do documento
Taxa de retenção na fonte
Veículo utilizado. Este campo apenas deve ser utilizado quando o tipo de documento emitido se trata de uma guia. Pode ser enviado o ID, matrícula ou nome.
Vendedor do documento. Pode ser enviado o ID ou o email.
Data de início de transporte da guia.
Determina se a guia se trata de uma guia global de transporte. Esta opção só pode ser utilizada se o documento a emitir se tratar de uma Guia de Transporte ou
Guia de Remessa. Se activo, os campos:
customer,
vat_number,
address,
city,
postal_code,
country,
delivery_address_address,
delivery_address_city,
delivery_address_postal_code,
delivery_address_country,
discharge_location e
location_destiny deixam de ter a obrigatoriedade de preenchimento e serão sempre automaticamente preenchidos pelo Facturalusa com as informações do cliente genérico.
Local de origem. Pode ser enviado o ID ou nome do local. No caso de não preenchimento será assumido o local de origem pré-definido.
Local de destino. Pode ser enviado o ID ou nome do local. Não será assumido nenhum valor se não for enviado nada.
Localidade de carga
Localidade de descarga
Data de carga
Data de descarga (prevista)
Lista de artigos que constam no documento.
ID ou referência do artigo
Descrição adicional a aparecer no documento
Preço unitário
Quantidade
Desconto percentual
Taxa de IVA a aplicar. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
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.
Idioma a ser impresso caso o estado do documento seja Terminado. Preencher com PT ou EN. No caso de não preenchimento será assumido o idioma pré-definido.
Formato a ser impresso caso o estado do documento seja Terminado. Preencher com A4 ou POS. No caso de não preenchimento será assumido o valor definido no tipo de documento (que por norma é A4).
Tamanho / largura do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à esquerda do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à direita do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em cima do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em baixo do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Determina se deve ou não gerar a impressão do documento caso o estado do mesmo seja Terminado. Se preenchido com true o documento será impresso; Se preenchido com false o documento não será impresso; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar via email o documento para o cliente caso o estado do mesmo seja Terminado. Se preenchido com true o documento será enviado; Se preenchido com false o documento não será enviado; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar SMS para o cliente caso o estado do documento seja Terminado. Se preenchido com true a SMS será enviada; Se preenchido com false a SMS não será enviada; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver SMS disponíveis.
Determina se deve ou não assinar o documento caso o estado do documento seja Terminado e caso o mesmo seja impresso. Se preenchido com true o documento será assinado; se preenchido com false o documento não será assinado; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver a Assinatura Digital activada e bem configurada.
Estado do documento. Deve ser enviado um dos seguintes valores: Rascunho ou Terminado.
{
"sale_reference_id": ..,
"issue_date": ..
"due_date": ..
...
"items":
[
{
"id": ..,
"details": ..
"price": ..
"quantity": ..
"discount": ..
"vat": ..
"vat_exemption": ..
}
],
}{
"status": true,
"data":
{
"id": ..,
"number": ..,
"issue_date": ..,
"due_date": ..,
"serie_id": ..,
"document_type_id": ..,
"gross_total": ..,
"total_discount": ..,
"net_total": ..,
"total_base_vat": ..,
"total_vat": ..,
"total_shipping": ..,
"total_services": ..,
"grand_total": ..,
"final_discount_financial": ..,
"final_discount_global": ..,
"final_discount_value": ..,
"customer_id": ..,
"customer_code": ..,
"customer_name": ..,
"customer_vat_number": ..,
"customer_country": ..,
"customer_city": ..,
"customer_address": ..,
"customer_postal_code": ..,
"customer_delivery_address_country": ..,
"customer_delivery_address_address": ..,
"customer_delivery_address_city": ..,
"customer_delivery_address_postal_code": ..,
"company_name": ..,
"company_vat_number": ..,
"company_country": ..,
"company_address": ..,
"company_city": ..,
"company_postal_code": ..,
"company_vat_scheme": ..,
"payment_method_id": ..,
"payment_condition_id": ..,
"shipping_mode_id": ..,
"shipping_value": ..,
"shipping_vat_id": ..,
"price_id": ..,
"currency_id": ..,
"currency_exchange": ..,
"vehicle_id": ..,
"employee_id": ..,
"waybill_shipping_date": ..,
"waybill_global": ..,
"location_origin_id": ..,
"location_origin_name": ..,
"location_origin_country": ..,
"location_origin_address": ..,
"location_origin_city": ..,
"location_origin_postal_code": ..,
"warehouse_origin_id": ..,
"warehouse_destiny_id": ..,
"location_destiny_id": ..,
"cargo_location": ..,
"discharge_location": ..,
"cargo_date": ..,
"discharge_date": ..,
"mb_entity": ..,
"mb_sub_entity": ..,
"mb_reference": ..,
"at_code": ..,
"at_message": ..,
"vat_type": ..,
"observations": ..,
"irs_retention_apply": ..,
"irs_retention_base": ..,
"irs_retention_total": ..,
"irs_retention_tax": ..,
"url_file": ..,
"file_previewed": ..,
"file_last_generated": ..,
"status": ..,
"status_last_change": ..,
"created_by": ..,
"finished_by": ..,
"canceled_by": ..,
"canceled_at": ..,
"canceled_reason": ..,
"updated_at": ..,
"created_at": ..,
"reference": [],
"serie": [],
"documenttype": [],
"documenttypeserie": [],
"paymentmethod": [],
"paymentcondition": [],
"shippingmode": [],
"shippingvat": [],
"price": [],
"currency": [],
"vehicle": [],
"employee": [],
"locationdestiny": [],
"warehouseorigin": [],
"warehousedestiny": [],
"vats": [],
"items": [],
"createdby": [],
"finishedby": [],
"canceledby": [],
"customercountry": [],
"accountopen": [],
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Apenas pode ser utilizado caso o documento se encontre em rascunho.
{
"status": true
}Apenas pode ser utilizado caso o documento se encontre terminado e ainda não tenha sido cancelado.
Justificação da anulação do documento. Obrigatório preencher no caso de documentos de Facturação (FT, FR, FS, NC, ND) e Guias.
{
"reason": ..,
}{
"status": true,
"url_file": ...
}Apenas pode ser utilizado caso o documento se encontre terminado.
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Factura, Factura Recibo, Factura Simplificada, Nota de Crédito, Nota de Débito, Factura Pró-forma, Orçamento, Encomenda, Guia de Transporte, Guia de Remessa, Guia de Consignação, Guia de Devolução, Guia de movimentação de activos próprios.
{
"document_type": ..,
}{
"status": true,
"id": ...
}Permite criar um Recibo de Cliente a partir da uma Factura FT, o documento é sempre criado no estado de Rascunho. Apenas pode ser utilizado caso o documento se encontre terminado e ainda não tenha sido cancelado.
{
"status": true,
"id": ...
}Apenas pode ser utilizado caso o documento se encontre terminado e ainda não tenha sido cancelado.
{
"status": true,
"id": ...
}Apenas pode ser utilizado caso o documento se encontre terminado e ainda não tenha sido cancelado.
{
"status": true,
"id": ...
}Apenas pode ser utilizado caso o documento se encontre terminado.
Idioma a ser impresso. Preencher com PT ou EN. No caso de não preenchimento será assumido o idioma previamente guardado.
Formato a ser impresso. Preencher com A4 ou POS. No caso de não preenchimento será assumido o formato previamente guardado.
Tamanho / largura do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à esquerda do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à direita do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em cima do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em baixo do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Via a imprimir. Preencher com 2ª via ou Original. No caso de não preenchimento será assumido 2ª via.
Nº de artigos a imprimir por página. No caso de não preenchimento será assumido o valor pré-definido.
{
"language": ..,
"format": ..,
"issue": ..,
"max_items_per_page": ..
}{
"status": true,
"url_file": ...
}Apenas pode ser utilizado caso o documento se encontre terminado.
Corpo do email. No caso de não preenchimento será assumido o corpo do email no template.
Para quem vai enviar o email
Nome
Cópia do email em CC para N emails. Valores separados por vírgula.
Permite adicionar 2 anexos adicionais. As extensões dos ficheiros autorizadas são:
png,
jpg,
jpeg,
bmp,
pdf,
doc,
docx,
xls,
xlsx,
zip,
7z,
rar,
csv,
txt,
xml,
Nome do ficheiro
URL do ficheiro
{
"subject": ..,
"message": ..,
"to": { "name": .., "email": .. },
"cc": email1,email2,
"attachments": [{ "filename": .., "url": ..}]
}{
"status": true
}Apenas pode ser utilizado caso o documento se encontre terminado.
Um ou mais nº de telemóvel
Nome
Nº de telemóvel. Sem espaços, sem +351, nº nacional.
Mensagem a enviar. No caso de não preenchimento será assumido a mensagem no template.
{
"to":
[
{
"name": ..,
"mobile": ..
}
],
"message": ..
}{
"status": true
}Apenas pode ser utilizado caso o documento se encontre terminado e ainda não tenha sido cancelado.
{
"status": true,
"data":
{
"entity" => ..,
"sub_entity" => ..,
"reference" => ..
}
}Apenas pode ser utilizado caso o documento se encontre terminado.
{
"status": true,
"url_file": ..
}Permite calcular em tempo real os totais (total de iva, total geral, etc) que vão ser emitidos no documento.
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Factura, Factura Recibo, Factura Simplificada, Nota de Crédito, Nota de Débito, Factura Pró-forma, Orçamento, Encomenda, Guia de Transporte, Guia de Remessa, Guia de Consignação, Guia de Devolução, Guia de movimentação de activos próprios.
Desconto financeiro €
Desconto global %
Modo de expedição. Pode ser enviado o ID ou o descritivo, exemplo: Correios, Comboio, etc.
Custo unitário da despesa de transporte
Taxa de IVA da despesa de transporte. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
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.
Câmbio da moeda. Caso não seja enviado será assumido 1.
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
Taxa de retenção na fonte
Lista de artigos que constam no documento.
ID ou referência do artigo
Descrição adicional a aparecer no documento
Preço unitário
Quantidade
Desconto percentual
Taxa de IVA a aplicar. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
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.
{
"document_type": ..,
"final_discount_financial": ..,
"final_discount_global": ..,
"shipping_mode": ..,
"shipping_value": ..,
"shipping_vat": ..,
"currency": ..,
"currency_exchange": ..,
"vat_type": ..,
"irs_retention_tax": ..,
"items":
[
{
"id": ..,
"details": ..
"price": ..
"quantity": ..
"discount": ..
"vat": ..
"vat_exemption": ..
}
],
}{
"status":true,
"data":
{
"gross_total": ..,
"total_discount": ..,
"net_total": ..,
"total_base_vat": ..,
"total_vat": ..,
"total_shipping": ..,
"grand_total": ..,
"grand_total_with_currency_exchange": ..,
"final_discount_financial": ..,
"final_discount_global": ..,
"final_discount_global_value": ..,
"total_services": ..,
"total_quantity": ..,
"irs_retention_apply": ..,
"irs_retention_base": ..,
"irs_retention_total": ..,
"irs_retention_tax": ..,
"items":
[
{
"sale_id": ..,
"item_id": ..,
"item_details": ..,
"price": ..,
"quantity": ..,
"discount": ..,
"gross_total": ..,
"net_total": ..,
"total_base_vat": ..,
"total_vat": ..,
"total_discount": ..,
"grand_total": ..,
"vat_id": ..,
"unit_id": ..,
"vat_exemption_id": ..,
}
],
"vats":
[
{
"sale_id": ..,
"vat_id": ..,
"vat_tax": ..,
"total_base_vat": ..,
"total_vat": ..,
}
]
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Permite procurar por uma venda.
Valor a procurar
Determina em que campo deve ser procurado. Deve ser enviado um dos seguintes valores: ID, Document Number. No caso da procura ser efectuada no nº do documento, a seguinte nomenclatura exemplo deve ser enviada: FT A/4921.
{
"value": ..,
"search_in": ..
}{
"status": true,
"data":
{
"id": ..,
"number": ..,
"issue_date": ..,
"due_date": ..,
...
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Devolve a lista de vendas. Devolve no máximo 15 resultados.
Valor a procurar
Determina em que campo deve ser procurado. Pode ser enviado um dos seguintes valores: ID, Document Number, Customer, Vat Number. No caso da procura ser efectuada no nº do documento, a seguinte nomenclatura exemplo deve ser enviada: FT A/4921.
Determina que tipos de documentos devolve. Pode ser enviado um dos seguintes valores: Facturação, Orçamentos, Encomendas, Guias.
Determina que indice deve saltar. Deve ser enviado um valor multiplicador de 15.
{
"value": ..,
"search_in": ..,
"type": ..,
"skip": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"number": ..,
"issue_date": ..,
"due_date": ..,
...
}
]
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Este endpoint visa gerir a emissão de recibos.
POST /receipts/create |
POST /receipts/:id/update |
POST /receipts/:id/delete |
POST /receipts/:id/cancel |
POST /receipts/:id/download |
POST /receipts/:id/send_email |
POST /receipts/:id/send_sms |
POST /receipts/:id/sign |
POST /receipts/summary |
POST /receipts/find |
POST /receipts/list |
Data de emissão do documento
Data de recebimento do documento
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Recibo de Cliente.
Série. Pode ser enviado o ID ou o descritivo, exemplo: 2021, 2021A, etc. No caso de não preenchimento será assumido a série pré-definida.
ID do cliente
Contribuinte do cliente. No caso de não preenchimento será assumido o valor 999999990.
Morada do cliente
Localidade do cliente
Código postal do cliente
País do cliente
Método de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.
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.
Câmbio da moeda. Caso não seja enviado será assumido 1.
Observações do documento
Local de origem. Pode ser enviado o ID ou nome do local. No caso de não preenchimento será assumido o local de origem pré-definido.
Lista de vendas que constam no documento.
ID da venda
Desconto percentual
Desconto unitário
Valor pago
Idioma a ser impresso caso o estado do documento seja Terminado. Preencher com PT ou EN. No caso de não preenchimento será assumido o idioma pré-definido.
Formato a ser impresso caso o estado do documento seja Terminado. Preencher com A4 ou POS. No caso de não preenchimento será assumido o valor definido no tipo de documento (que por norma é A4).
Tamanho / largura do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à esquerda do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à direita do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em cima do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em baixo do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Determina se deve ou não gerar a impressão do documento caso o estado do mesmo seja Terminado. Se preenchido com true o documento será impresso; se preenchido com false o documento não será impresso; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar via email o documento para o cliente caso o estado do mesmo seja Terminado. Se preenchido com true o documento será enviado; se preenchido com false o documento não será enviado; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar SMS para o cliente caso o estado do documento seja Terminado. Se preenchido com true a SMS será enviada; se preenchido com false a SMS não será enviada; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver SMS disponíveis.
Determina se deve ou não assinar o documento caso o estado do documento seja Terminado e caso o mesmo seja impresso. Se preenchido com true o documento será assinado; se preenchido com false o documento não será assinado; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver a Assinatura Digital activada e bem configurada.
Estado do documento. Deve ser enviado um dos seguintes valores: Rascunho ou Terminado.
{
"issue_date": ..
"receipt_date": ..
...
"sales":
[
{
"id": ..,
"percentage_discount": ..
"unit_discount": ..
"total_paid": ..
}
],
}{
"status": true,
"data":
{
"id": ..,
"number": ..,
"issue_date": ..,
"receipt_date": ..,
"serie_id": ..,
"document_type_id": ..,
"total_discount": ..,
"total_balance": ..,
"total_paid": ..,
"grand_total": ..,
"customer_id": ..,
"customer_code": ..,
"customer_name": ..,
"customer_vat_number": ..,
"customer_country": ..,
"customer_city": ..,
"customer_address": ..,
"customer_postal_code": ..,
"company_name": ..,
"company_vat_number": ..,
"company_country": ..,
"company_address": ..,
"company_city": ..,
"company_postal_code": ..,
"company_vat_scheme": ..,
"payment_method_id": ..,
"currency_id": ..,
"currency_exchange": ..,
"location_origin_id": ..,
"location_origin_name": ..,
"location_origin_country": ..,
"location_origin_address": ..,
"location_origin_city": ..,
"location_origin_postal_code": ..,
"observations": ..,
"url_file": ..,
"file_previewed": ..,
"file_last_generated": ..,
"status": ..,
"status_last_change": ..,
"created_by": ..,
"finished_by": ..,
"canceled_by": ..,
"canceled_at": ..,
"canceled_reason": ..,
"updated_at": ..,
"created_at": ..,
"serie": [],
"documenttype": [],
"documenttypeserie": [],
"paymentmethod": [],
"currency": [],
"sales": [],
"createdby": [],
"finishedby": [],
"canceledby": [],
"customercountry": [],
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Apenas pode ser utilizado caso o documento se encontre em rascunho.
Data de emissão do documento
Data de recebimento do documento
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Recibo de Cliente.
Série. Pode ser enviado o ID ou o descritivo, exemplo: 2021, 2021A, etc. No caso de não preenchimento será assumido a série pré-definida.
ID do cliente
Contribuinte do cliente. No caso de não preenchimento será assumido o valor 999999990.
Morada do cliente
Localidade do cliente
Código postal do cliente
País do cliente
Método de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.
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.
Câmbio da moeda. Caso não seja enviado será assumido 1.
Observações do documento
Local de origem. Pode ser enviado o ID ou nome do local. No caso de não preenchimento será assumido o local de origem pré-definido.
Lista de vendas que constam no documento.
ID da venda
Desconto percentual
Desconto unitário
Valor pago
Idioma a ser impresso caso o estado do documento seja Terminado. Preencher com PT ou EN. No caso de não preenchimento será assumido o idioma pré-definido.
Formato a ser impresso caso o estado do documento seja Terminado. Preencher com A4 ou POS. No caso de não preenchimento será assumido o valor definido no tipo de documento (que por norma é A4).
Tamanho / largura do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à esquerda do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à direita do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em cima do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em baixo do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Se deve forçar a impressão do documento caso o estado do documento seja Terminado. No caso de não preenchimento será assumido o valor definido no tipo de documento (que por norma é Sim).
Determina se deve ou não gerar a impressão do documento caso o estado do mesmo seja Terminado. Se preenchido com true o documento será impresso; se preenchido com false o documento não será impresso; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar via email o documento para o cliente caso o estado do mesmo seja Terminado. Se preenchido com true o documento será enviado; se preenchido com false o documento não será enviado; se não for preenchido, irá assumir o valor definido no tipo de documento.
Determina se deve ou não enviar SMS para o cliente caso o estado do documento seja Terminado. Se preenchido com true a SMS será enviada; se preenchido com false a SMS não será enviada; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver SMS disponíveis.
Determina se deve ou não assinar o documento caso o estado do documento seja Terminado e caso o mesmo seja impresso. Se preenchido com true o documento será assinado; se preenchido com false o documento não será assinado; se não for preenchido, irá assumir o valor definido no tipo de documento. Esta funcionalidade só funciona se tiver a Assinatura Digital activada e bem configurada.
Estado do documento. Deve ser enviado um dos seguintes valores: Rascunho ou Terminado.
{
"issue_date": ..
"receipt_date": ..
...
"sales":
[
{
"id": ..,
"percentage_discount": ..
"unit_discount": ..
"total_paid": ..
}
],
}{
"status": true,
"data":
{
"id": ..,
"number": ..,
"issue_date": ..,
"receipt_date": ..,
"serie_id": ..,
"document_type_id": ..,
"total_discount": ..,
"total_balance": ..,
"total_paid": ..,
"grand_total": ..,
"customer_id": ..,
"customer_code": ..,
"customer_name": ..,
"customer_vat_number": ..,
"customer_country": ..,
"customer_city": ..,
"customer_address": ..,
"customer_postal_code": ..,
"company_name": ..,
"company_vat_number": ..,
"company_country": ..,
"company_address": ..,
"company_city": ..,
"company_postal_code": ..,
"company_vat_scheme": ..,
"payment_method_id": ..,
"currency_id": ..,
"currency_exchange": ..,
"location_origin_id": ..,
"location_origin_name": ..,
"location_origin_country": ..,
"location_origin_address": ..,
"location_origin_city": ..,
"location_origin_postal_code": ..,
"observations": ..,
"url_file": ..,
"file_previewed": ..,
"file_last_generated": ..,
"status": ..,
"status_last_change": ..,
"created_by": ..,
"finished_by": ..,
"canceled_by": ..,
"canceled_at": ..,
"canceled_reason": ..,
"updated_at": ..,
"created_at": ..,
"serie": [],
"documenttype": [],
"documenttypeserie": [],
"paymentmethod": [],
"currency": [],
"sales": [],
"createdby": [],
"finishedby": [],
"canceledby": [],
"customercountry": [],
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Apenas pode ser utilizado caso o documento se encontre em rascunho.
{
"status": true
}Apenas pode ser utilizado caso o documento se encontre terminado e ainda não tenha sido cancelado.
Justificação da anulação do documento
{
"reason": ..,
}{
"status": true,
"url_file": ...
}Apenas pode ser utilizado caso o documento se encontre terminado.
Idioma a imprimir o documento. Preencher com PT ou EN. No caso de não preenchimento será assumido o idioma pré-definido.
Formato a ser impresso caso o estado do documento seja Terminado. Preencher com A4 ou POS. No caso de não preenchimento será assumido o formato pré-definido (que por norma é A4).
Tamanho / largura do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à esquerda do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem à direita do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em cima do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
Margem em baixo do documento. Apenas deve ser preenchido caso o formato seja POS. No caso de não preenchimento será assumido o valor definido no tipo de documento.
{
"language": ..,
"format": ..,
}{
"status": true,
"url_file": ...
}Apenas pode ser utilizado caso o documento se encontre terminado.
Corpo do email. No caso de não preenchimento será assumido o corpo do email no template.
Para quem vai enviar o email
Nome
Cópia do email em CC para N emails. Valores separados por vírgula.
Permite adicionar 2 anexos adicionais. As extensões dos ficheiros autorizadas são:
png,
jpg,
jpeg,
bmp,
pdf,
doc,
docx,
xls,
xlsx,
zip,
7z,
rar,
csv,
txt,
xml,
Nome do ficheiro
URL do ficheiro
{
"subject": ..,
"message": ..,
"to": { "name": .., "email": .. },
"cc": email1,email2,
"attachments": [{ "filename": .., "url": ..}]
}{
"status": true
}Apenas pode ser utilizado caso o documento se encontre terminado.
Um ou mais nº de telemóvel
Nome
Nº de telemóvel. Sem espaços, sem +351, nº nacional.
Mensagem a enviar. No caso de não preenchimento será assumido a mensagem no template.
{
"to":
[
{
"name": ..,
"mobile": ..
}
],
"message": ..
}{
"status": true
}Apenas pode ser utilizado caso o documento se encontre terminado.
{
"status": true,
"url_file": ..
}Permite calcular em tempo real os totais (total geral, total em saldo, etc) que vão ser emitidos no documento.
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Recibo de Cliente.
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.
Câmbio da moeda. Caso não seja enviado será assumido 1.
Lista de vendas que constam no documento.
ID da venda
Desconto percentual
Desconto unitário
Valor pago
{
"document_type": ..,
"currency": ..,
"currency_exchange": ..,
"sales":
[
{
"id": ..,
"percentage_discount": ..
"unit_discount": ..
"total_paid": ..
}
],
}{
"status":true,
"data":
{
"grand_total": ..,
"grand_total_with_currency_exchange": ..,
"total_balance": ..,
"total_discount": ..,
"total_paid": ..,
"sales":
[
{
"sale_id": ..,
"receipt_id": ..,
"grand_total": ..
"percentage_discount": ..
"total_balance": ..
"total_paid": ..
"unit_discount": ..
}
],
}
}Permite procurar por um recibo.
Valor a procurar
Determina em que campo deve ser procurado. Deve ser enviado um dos seguintes valores: ID, Document Number. No caso da procura ser efectuada no nº do documento, a seguinte nomenclatura exemplo deve ser enviada: RG A/4921.
{
"value": ..,
"search_in": ..
}{
"status": true,
"data":
{
"id": ..,
"number": ..,
"issue_date": ..,
"receipt_date": ..,
...
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Devolve a lista de recibos. Devolve no máximo 15 resultados.
Valor a procurar
Determina em que campo deve ser procurado. Pode ser enviado um dos seguintes valores: ID, Document Number, Customer, Vat Number. No caso da procura ser efectuada no nº do documento, a seguinte nomenclatura exemplo deve ser enviada: FT A/4921.
Determina que indice deve saltar. Deve ser enviado um valor multiplicador de 15.
{
"value": ..,
"search_in": ..
"skip": ..
}{
"status": true,
"data":
{
"id": ..,
"number": ..,
"issue_date": ..,
"receipt_date": ..,
...
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
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 |
O cliente é sempre criado no estado activo.
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.
Nome
Contribuinte
País
Morada
Localidade
Código postal
Telefone
Telemóvel. Evite espaços e +351.
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.
Método de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.
Condição de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Pronto pagamento, 30 dias, etc.
Modo de expedição. Pode ser enviado o ID ou o descritivo, exemplo: Correios, Comboio, etc.
Tabela de preços utilizada. Pode ser enviado o ID ou o descritivo, exemplo: Preços público, Preços revenda, etc.
Vendedor que adquiriu o cliente. Pode ser enviado o ID ou o email.
Tipo de cliente. Deve ser enviado um dos seguintes valores: Empresarial, Particular.
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
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.
Taxa de retenção na fonte
Observações do cliente
Outros contactos
Outros emails. Emails separados por vírgula.
Determina se o cliente está apto a receber notificações de SMS despoletadas automaticamente
Determina se o cliente está apto a receber notificações de Emails despoletadas automaticamente
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.
Lista de moradas de entrega.
País
Morada
Localidade
Código postal
{
"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": []
}{
"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.
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.
Nome
Contribuinte
País
Morada
Localidade
Código postal
Telefone
Telemóvel. Evite espaços e +351.
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.
Método de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.
Condição de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Pronto pagamento, 30 dias, etc.
Modo de expedição. Pode ser enviado o ID ou o descritivo, exemplo: Correios, Comboio, etc.
Tabela de preços utilizada. Pode ser enviado o ID ou o descritivo, exemplo: Preços público, Preços revenda, etc.
Vendedor que adquiriu o cliente. Pode ser enviado o ID ou o email.
Tipo de cliente. Deve ser enviado um dos seguintes valores: Empresarial, Particular.
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
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.
Taxa de retenção na fonte
Observações do cliente
Outros contactos
Outros emails. Emails separados por vírgula.
Estado
Determina se o cliente está apto a receber notificações de SMS despoletadas automaticamente
Determina se o cliente está apto a receber notificações de Emails despoletadas automaticamente
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.
Lista de moradas de entrega.
País
Morada
Localidade
Código postal
{
"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": ..,
"active": ..,
"addresses": []
}{
"status": true
}Apenas pode ser utilizado caso o cliente ainda não tenha sido utilizado em nenhum documento.
{
"status": true
}Permite procurar por clientes. Devolve no máximo 15 resultados.
Valor a procurar
Determina em que campo deve ser procurado. Pode ser enviado um dos seguintes valores: ID, Code, Name, Email, Vat Number, Mobile.
Devolve a lista de clientes. Devolve no máximo 15 resultados.
Determina que indice deve saltar. Deve ser enviado um valor multiplicador de 15.
Define que estados de clientes deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
Devolve a lista de valores em aberto por saldar (documentos de facturação) para um cliente. Essencial para a emissão de recibos.
{
"status": true,
"data":
[
{
"id": ..,
"sale_id": ..,
"debit": ..,
"credit": ..,
"balance": ..,
"currency_id": ..,
"currency_exchange": ..,
"sale": [],
"currency": [],
}
]
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Efectua o download em formato PDF A4 do Extracto de Contas em Aberto relativo ao cliente.
Data de
Data até
{
"date_from": ..,
"date_to": ..
}{
"status": true,
"url_file": ..
}Envia via email o PDF A4 do Extracto de Contas em Aberto relativo ao cliente.
Assunto do email
Corpo do email
Para quem vai enviar o email
Nome
Cópia do email em CC para N emails. Valores separados por vírgula.
{
"subject": ..,
"message": ..
"to": { name: .., email: .. },
"cc": email1,email2
}{
"status": true
}Devolve a lista de valores em aberto por saldar (documentos de facturação) de todos os clientes.
Valor a procurar
Determina em que campo deve ser procurado. Pode ser enviado um dos seguintes valores: ID, Code, Name, Email, Vat Number, Mobile.
Determina que indice deve saltar. Deve ser enviado um valor multiplicador de 15.
{
"value": ..
"search_in": ..
"skip": ..
}{
"status": true,
"data":
[
{
"id": ..,
"sale_id": ..,
"debit": ..,
"credit": ..,
"balance": ..,
"currency_id": ..,
"currency_exchange": ..,
"sale": [],
"customer": [],
"currency": [],
}
]
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Este endpoint visa gerir os artigos.
POST /items/create |
POST /items/:id/update |
POST /items/:id/delete |
POST /items/:id/delete_image |
POST /items/find |
POST /items/list |
POST /items/stock/movements/create |
POST /items/stock/movements/:id/update |
POST /items/stock/movements/:id/delete |
POST /items/:id/stock/actual |
O artigo é sempre criado no estado activo. Caso decida fazer o upload da imagem, o Content-Type enviado nos Headers deve ser multipart/form-data ou application/x-www-form-urlencoded.
Referência do artigo. Se não for enviado nenhum valor vai ser dado seguimento à última referência ou gerado uma referência aleatória.
Descrição
Descrição detalhada do artigo
Se mostra a descrição detalhada na impressão
Categoria do artigo. Deve ser enviado o ID.
Unidade de medida. Pode ser enviado o ID, descritivo ou símbolo, exemplo: cm, kg, Kilos, etc.
Taxa de IVA a aplicar. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
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.
Tipo de contabilidade. Deve ser enviado um dos seguintes valores: Embalagens, Matérias primas, Mercadorias, Produtos acabados e intermédios, Serviços, Subprodutos, Transporte, Vasilhame.
Preço de custo do artigo
Observações do artigo
Imagem do artigo
Lista de preços a aplicar
ID da tabela de preços
Preço
Desconto
Lista de códigos barras
Código
Quantidade
Descrição
Lista de stock mínimo (alerta) por armazém
ID da tabela de armazéns
Quantidade
{
"reference": ..,
"description": ..,
"details": ..,
"details_show_print": ..,
"category": ..,
"unit": ..,
"vat": ..,
"vat_exemption": ..
"type": ..,
"cost_price": ..,
"observations": ..,
"prices": []
"barcodes": []
"minimum_stock": []
}{
"status": true,
"data":
{
"id": ..,
"reference": ..,
"description": ..,
"details": ..,
"details_show_print": ..,
"category_id": ..,
"unit_id": ..,
"vat_id": ..,
"vat_exemption_id": ..
"type": ..,
"cost_price": ..,
"observations": ..,
"url_image": ..,
"reference_blocked": ..,
"description_blocked": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
"category": []
"prices": []
"barcodes": []
"averagecostprices": []
"minimumstock": []
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Caso decida fazer o upload da imagem, o Content-Type enviado nos Headers deve ser multipart/form-data ou application/x-www-form-urlencoded.
Referência do artigo. Se não for enviado nenhum valor vai ser dado seguimento à última referência ou gerado uma referência aleatória.
Descrição
Descrição detalhada do artigo
Se mostra a descrição detalhada na impressão
Categoria do artigo. Deve ser enviado o ID.
Unidade de medida. Pode ser enviado o ID, descritivo ou símbolo, exemplo: cm, kg, Kilos, etc.
Taxa de IVA a aplicar. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
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.
Tipo de contabilidade. Deve ser enviado um dos seguintes valores: Embalagens, Matérias primas, Mercadorias, Produtos acabados e intermédios, Serviços, Subprodutos, Transporte, Vasilhame.
Preço de custo do artigo
Observações do artigo
Imagem do artigo
Estado
Lista de preços a aplicar
ID da tabela de preços
Preço
Desconto
Lista de códigos barras
Código
Quantidade
Descrição
Lista de stock mínimo (alerta) por armazém
ID da tabela de armazéns
Quantidade
{
"reference": ..,
"description": ..,
"details": ..,
"details_show_print": ..,
"category_id": ..,
"unit": ..,
"vat": ..,
"vat_exemption": ..
"type": ..,
"cost_price": ..,
"observations": ..,
"prices": []
"barcodes": []
"minimum_stock": []
}{
"status": true
}Apenas pode ser utilizado caso o artigo ainda não tenha sido utilizado em nenhum documento.
{
"status": true
}Elimina a imagem do artigo.
{
"status": true
}Permite procurar por artigos. Devolve no máximo 15 resultados.
Valor a procurar
Determina em que campo deve ser procurado. Pode ser enviado um dos seguintes valores: ID, Reference, Description, Barcode.
Este endpoint devolve o total em stock do artigo para todos os armazéns.
{
"value": ..,
"search_in": ..
}{
"status": true,
"data":
[
{
"id": ..,
"reference": ..,
"description": ..,
"details": ..,
...
}
]
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Devolve a lista de artigos. Devolve no máximo 15 resultados.
Determina que indice deve saltar. Deve ser enviado um valor multiplicador de 15.
Define que estados de artigos deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
Este endpoint devolve o total em stock do artigo para todos os armazéns.
Cria um novo movimento de stock.
Armazém. Pode ser enviado o ID ou o descritivo.
Artigo. Pode ser enviado o ID ou a referência. Obrigatoriamente deve ser um artigo do tipo Mercadorias.
Data do movimento
Tipo de movimento. Deve ser enviado um dos seguintes valores: Entrada, Saída.
Quantidade de stock
Preço unitário
{
"warehouse": ..,
"item": ..
"date": ..
"type": ..
"quantity": ..
"unit_price": ..
}{
"status": true,
"id": ..
}Actualiza um movimento de stock existente. Tem repercussões nos Preços Médios de Custo. Apenas é possível actualizar movimentos de stock que foram criados manualmente.
Armazém. Pode ser enviado o ID ou o descritivo.
Artigo. Pode ser enviado o ID ou a referência. Obrigatoriamente deve ser um artigo do tipo Mercadorias.
Data do movimento
Tipo de movimento. Deve ser enviado um dos seguintes valores: Entrada, Saída.
Quantidade de stock
Preço unitário
{
"warehouse": ..,
"item": ..
"date": ..
"type": ..
"quantity": ..
"unit_price": ..
}{
"status": true
}Elimina um movimento de stock existente. Tem repercussões nos Preços Médios de Custo. Apenas é possível eliminar movimentos de stock que foram criados manualmente.
{
"status": true
}Obtém o stock actual para determinado artigo. O endpoint devolve a soma (total) bem como as estatísticas do ano mencionado.
Armazém. Pode ser enviado o ID ou o descritivo. No caso de não preenchimento será devolvido o stock de todos os armazéns.
Ano do stock. No caso de não preenchimento será assumido o ano actual.
O valor do campo devolvido stats_year é um array multidimensional onde consta o total de entradas, total de saídas e balanço, por esta ordem.
{
"warehouse": ..,
"year": ..
}{
"status": true,
"data":
[
{
"quantity_in": ..,
"quantity_out": ..,
"balance": ..,
"average_cost_price": ..,
"stats_year": ..,
"warehouse": ..
}
]
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
Este endpoint visa gerir todas as tabelas de auxiliares.
Devolve a lista de todos os endpoints disponíveis nos menus Administração & Subscrição. Apenas devolve os itens que se encontrem activos e caso possua permissões de leitura.
{
"status": true,
"data":
{
"categories": [],
"countries": [],
"currencies": [],
"documents_types": [],
"employees": [],
...
}
}Descrição
Estado
{
"description": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Estado
{
"description": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso o armazém ainda não tenha sido utilizado em nenhum documento.
{
"status": true
}Permite procurar por armazéns.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de armazéns.
Define que estados de armazéns deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
ID da categoria pai
Estado
{
"description": ..,
"category_id": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"category_id": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
ID da categoria pai
Estado
{
"description": ..,
"category_id": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"category_id": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso a categoria ainda não tenha sido utilizado em nenhum artigo.
{
"status": true
}Permite procurar por categorias.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"category_id": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de categorias.
Define que estados de categorias deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"category_id": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Nome
País
Morada
Localidade
Código postal
Telefone
Telemóvel
IBAN
Vendedor
Estado
{
"name": ..,
"country": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"email": ..,
"telephone": ..,
"mobile": ..,
"bank_number": ..,
"is_salesman": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"name": ..,
"country": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"email": ..,
"telephone": ..,
"mobile": ..,
"bank_number": ..,
"is_salesman": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Nome
País
Morada
Localidade
Código postal
Telefone
Telemóvel
IBAN
Vendedor
Estado
{
"name": ..,
"country": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"email": ..,
"telephone": ..,
"mobile": ..,
"bank_number": ..,
"is_salesman": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"name": ..,
"country": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"email": ..,
"telephone": ..,
"mobile": ..,
"bank_number": ..,
"is_salesman": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso o colaborador ainda não tenha sido utilizado em nenhum documento / cliente.
{
"status": true
}Permite procurar por colaboradores.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"name": ..,
"country": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"email": ..,
"telephone": ..,
"mobile": ..,
"bank_number": ..,
"is_salesman": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de colaboradores.
Define que estados de colaboradores deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"name": ..,
"country": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"email": ..,
"telephone": ..,
"mobile": ..,
"bank_number": ..,
"is_salesman": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Descrição em inglês
Nº de dias
Estado
{
"description": ..,
"description_english": ..,
"days": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"description_english": ..,
"days": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Descrição em inglês
Nº de dias
Estado
{
"description": ..,
"description_english": ..,
"days": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"description_english": ..,
"days": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso a condição de pagamento ainda não tenha sido utilizado em nenhum documento / cliente.
{
"status": true
}Permite procurar por formas de pagamento.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"description_english": ..,
"days": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de formas de pagamento.
Define que estados de formas de pagamento deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"description_english": ..,
"days": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Descrição em inglês
Estado
{
"description": ..,
"description_english": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"description_english": ..,
"saft_initials": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Descrição em inglês
Estado
{
"description": ..,
"description_english": ..,
"saft_initials": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"description_english": ..,
"saft_initials": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso a forma de pagamento ainda não tenha sido utilizado em nenhum documento / cliente.
{
"status": true
}Permite procurar por formas de pagamento.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"description_english": ..,
"saft_initials": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de formas de pagamento.
Define que estados de formas de pagamento deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"description_english": ..,
"saft_initials": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Descrição em inglês
Estado
{
"description": ..,
"description_english": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"description_english": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Descrição em inglês
Estado
{
"description": ..,
"description_english": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"description_english": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso o modo de expedição ainda não tenha sido utilizado em nenhum documento.
{
"status": true
}Permite procurar por modos de expedição.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"description_english": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de modos de expedição.
Define que estados de modos de expedição deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"description_english": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Símbolo
Código ISO
Câmbio de venda
Pré-definido
Estado
{
"description": ..,
"symbol": ..,
"code_iso": ..,
"exchange_sale": ..,
"is_default": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"symbol": ..,
"code_iso": ..,
"exchange_sale": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Símbolo
Código ISO
Câmbio de venda
Pré-definido
Estado
{
"description": ..,
"symbol": ..,
"code_iso": ..,
"exchange_sale": ..,
"is_default": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"symbol": ..,
"code_iso": ..,
"exchange_sale": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso a moeda ainda não tenha sido utilizada em nenhum documento / cliente.
{
"status": true
}Permite procurar por moedas.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"symbol": ..,
"code_iso": ..,
"exchange_sale": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de moedas.
Define que estados de moedas deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"symbol": ..,
"code_iso": ..,
"exchange_sale": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Pré-definido
Estado
{
"description": ..,
"is_default": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Pré-definido
Estado
{
"description": ..,
"is_default": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso o preço ainda não tenha sido utilizado em nenhum documento / artigo.
{
"status": true
}Permite procurar por preços.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de preços.
Define que estados de preços deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"is_default": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Válido até. Preencher apenas com o ano.
Determina se deve atribuir de imediato a série a todos os tipos de documento
Determina se deve colocar a série como pré-definida
Determina se deve comunicar a série à AT. Necessário que a configuração do utilizador de acesso aos serviços AT esteja correctamente configurado.
Determina quais os tipos de documentos a comunicar à AT com a respectiva série. Só necessário preencher caso o parâmetro communicate seja true.
Estado
{
"description": ..,
"valid_until": ..,
"assign_to_all": ..,
"assign_as_default": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"valid_until": ..,
"type": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Válido até. Preencher apenas com o ano.
Estado
{
"description": ..,
"valid_until": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"valid_until": ..,
"type": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso a série ainda não tenha sido utilizado em nenhum documento.
{
"status": true
}Permite comunicar uma série à Autoridade Tributária para todos os tipos de documento em que esta esteja atribuída.
{
"status": true,
}Permite procurar por série.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"valid_until": ..,
"type": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de séries.
Define que estados de séries deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"valid_until": ..,
"type": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de séries por tipo de documento.
ID da tabela tipos de documento
{
"document_type_id": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"valid_until": ..,
"type": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Taxa %
Tipo de taxa. Deve ser enviado um dos seguintes valores: Normal, Intermédia, Isenta, Reduzida.
Região do SAF-T. Deve ser enviado um dos seguintes valores: PT, PT-AC, PT-MA. Também pode ser enviado um valor de acordo a norma ISO 3166, nomeadamente Alpha-2 Code.
Estado
{
"description": ..,
"tax": ..,
"type": ..,
"saft_region": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"tax": ..,
"type": ..,
"saft_region": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Taxa %
Tipo de taxa. Deve ser enviado um dos seguintes valores: Normal, Intermédia, Isenta, Reduzida.
Região do SAF-T. Deve ser enviado um dos seguintes valores: PT, PT-AC, PT-MA. Também pode ser enviado um valor de acordo a norma ISO 3166, nomeadamente Alpha-2 Code.
Estado
{
"description": ..,
"tax": ..,
"type": ..,
"saft_region": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"tax": ..,
"type": ..,
"saft_region": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso a Taxa de IVA ainda não tenha sido utilizado em nenhum documento / artigo.
{
"status": true
}Permite procurar por Taxas de IVA.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"tax": ..,
"type": ..,
"saft_region": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de Taxas de IVA.
Define que estados de Taxas de IVA deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"tax": ..,
"type": ..,
"saft_region": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Formato de papel. Deve ser enviado um dos seguintes valores: A4, POS.
Largura do papel. Apenas obrigatório caso o valor do campo print_report seja POS. Tamanho em milímetros.
Nº de vias a imprimir. Apenas obrigatório caso o valor do campo print_report seja A4.
Margem superior
Margem inferior
Margem direita
Margem esquerda
Define se deve emitir de imediato o PDF após terminar o documento
Define se deve assinar digitalmente o PDF após terminar o documento
Define se envia automaticamente um email (com o anexo do PDF emitido) ao cliente após terminar o documento
Define se envia automaticamente uam SMS ao cliente após terminar o documento
Define se é possível terminar o documento caso o stock do artigo seja negativo
Define se deve alertar o utilizador caso o stock do artigo ultrapasse o stock mínimo definido
Lista de séries que constam no tipo de documento
ID da série
Nº documento (deve-se iniciar no 1)
Pré-definido
Estado
Estado
{
"print_report": ..,
"print_width": ..,
"print_pages_number": ..,
"print_margin_top": ..,
"print_margin_bottom": ..,
"print_margin_right": ..,
"print_margin_left": ..,
"print_automatic": ..,
"sign_document_automatic": ..,
"send_email_automatic": ..,
"send_sms_automatic": ..,
"stock_check_negative": ..,
"stock_check_minimum": ..,
"series": [],
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"saft_initials": ..,
"type": ..,
"print_report": ..,
"print_report_width": ..,
"print_pages_number": ..,
"print_margin_top": ..,
"print_margin_bottom": ..,
"print_margin_right": ..,
"print_margin_left": ..,
"print_automatic": ..,
"sign_document_automatic": ..,
"send_email_automatic": ..,
"send_sms_automatic": ..,
"stock_check_negative": ..,
"stock_check_minimum": ..,
"active": ..,
"documentstypesseries": []
"updated_at": ..,
"created_at": ..,
}
}Permite comunicar uma série, por tipo de documento, à Autoridade Tributária.
{
"status": true,
"atcud": ..
}Permite procurar por tipos de documento.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"saft_initials": ..,
"type": ..,
"print_report": ..,
"print_report_width": ..,
"print_pages_number": ..,
"print_margin_top": ..,
"print_margin_bottom": ..,
"print_margin_right": ..,
"print_margin_left": ..,
"print_automatic": ..,
"sign_document_automatic": ..,
"send_email_automatic": ..,
"send_sms_automatic": ..,
"stock_check_negative": ..,
"stock_check_minimum": ..,
"active": ..,
"documentstypesseries": []
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de tipos de documento.
Define que estados de tipos de documento deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"saft_initials": ..,
"type": ..,
"print_report": ..,
"print_report_width": ..,
"print_pages_number": ..,
"print_margin_top": ..,
"print_margin_bottom": ..,
"print_margin_right": ..,
"print_margin_left": ..,
"print_automatic": ..,
"sign_document_automatic": ..,
"send_email_automatic": ..,
"send_sms_automatic": ..,
"stock_check_negative": ..,
"stock_check_minimum": ..,
"active": ..,
"documentstypesseries": []
"updated_at": ..,
"created_at": ..,
}
]
}Nome
Matrícula
Estado
{
"name": ..,
"license_plate": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"name": ..,
"license_plate": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Nome
Matrícula
Estado
{
"name": ..,
"license_plate": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"name": ..,
"license_plate": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso o veículo ainda não tenha sido utilizado em nenhum documento.
{
"status": true
}Permite procurar por veículos.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"name": ..,
"license_plate": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de veículos.
Define que estados de veículos deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"name": ..,
"license_plate": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Descrição
Símbolo
Estado
{
"description": ..,
"symbol": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"symbol": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Descrição
Símbolo
Estado
{
"description": ..,
"symbol": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"description": ..,
"symbol": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso a unidade ainda não tenha sido utilizada em nenhum documento / artigo.
{
"status": true
}Permite procurar por unidades.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"symbol": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de unidades.
Define que estados de unidades deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"description": ..,
"symbol": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Este endpoint visa gerir todas as tabelas de subscrição.
Nome
Morada
Localidade
Código postal
País
Telefone
Tipo de local. Preencher com Interno ou Externo.
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Factura, Factura Recibo, Factura Simplificada, Nota de crédito ou Nota de débito
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
Armazém. Pode ser enviado o ID ou o descritivo.
Estado
{
"name": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"country": ..,
"telephone": ..,
"type": ..,
"document_type": ..,
"vat_type": ..,
"warehouse": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"name": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"country": ..,
"telephone": ..,
"type": ..,
"document_type": ..,
"vat_type": ..,
"warehouse": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Nome
Morada
Localidade
Código postal
País
Telefone
Tipo de local. Preencher com Interno ou Externo.
Tipo de documento. Pode ser enviado o ID ou o descritivo, exemplo: Factura, Factura Recibo, Factura Simplificada, Nota de crédito ou Nota de débito
Tipo de IVA. Deve ser enviado um dos seguintes valores: Debitar IVA, IVA incluído, Não fazer nada.
Armazém. Pode ser enviado o ID ou o descritivo.
Estado
{
"name": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"country": ..,
"telephone": ..,
"type": ..,
"document_type": ..,
"vat_type": ..,
"warehouse": ..,
"active": ..,
"active": ..,
}{
"status": true,
"data":
{
"id": ..,
"name": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"country": ..,
"telephone": ..,
"type": ..,
"document_type": ..,
"vat_type": ..,
"warehouse": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
}Apenas pode ser utilizado caso o local ainda não tenha sido utilizado em nenhuma venda / recibo.
{
"status": true
}Permite procurar por locais.
Valor a procurar
{
"value": ..,
}{
"status": true,
"data":
[
{
"id": ..,
"name": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"country": ..,
"telephone": ..,
"type": ..,
"document_type": ..,
"vat_type": ..,
"warehouse": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}Devolve a lista de locais.
Define que estados de locais deve retornar. Deve ser enviado um dos seguintes valores: true, false, All.
{
"active": ..
}{
"status": true,
"data":
[
{
"id": ..,
"name": ..,
"address": ..,
"city": ..,
"postal_code": ..,
"country": ..,
"telephone": ..,
"type": ..,
"document_type": ..,
"vat_type": ..,
"warehouse": ..,
"active": ..,
"updated_at": ..,
"created_at": ..,
}
]
}