Apêndice

Documento do Recibo

Parâmetros
Tipo
Descrição
Obrigatório

id

integer

ID do Documento a usar na Linha

Pode referir-se tanto ao 'código' como ao 'código de barras' de um produto, ou ainda a um 'código alternativo' por este usado.

amount

float

Valor a Liquidar

Se não fornecido, a linha será lançada com o valor total ainda por liquidar do documento.

{
    "id": 1,
    "amount": 100.0
}

Pagamento do Recibo

Parâmetros
Tipo
Descrição
Obrigatório

payment_method_id

integer

Método de Pagamento

Consulte a tabela Métodos de Pagamento.

amount_received_currency

float

Valor do Pagamento Default: Valor em Dívida

payment_doc_reference

string

Referência do Pagamento

O preenchimento deste campo é obrigatório em alguns métodos de pagamento.

payment_doc_date

date

Data do Documento de Pagamento

(Ex: Data do Cheque bancário)

Impressão do Recibo

Parâmetros
Tipo
Descrição
Obrigatório

print

boolean

Imprimir Documento

Apenas pode imprimir documentos finalizados/anulados.

format

string

Formato de Impressão:

Opções: [a4/a5/ticket].

Caso não indique, será usado o formato configurado no documento.

print_copies

number

Número de cópias.

Opções: [1-6] / 2via.

Caso não indique, será impresso o número de cópias configurado no documento.

print_copy

number

Indica o número da cópia a imprimir

Opções: [1-6] / 2via.

Caso pretenda imprimir apenas uma cópia específica (Ex: Imprimir apenas triplicado)

layout_id

integer

Layout de Impressão

Caso não indique, será usado o layout configurado no documento de acordo com o formato de impressão.

Envio por E-mail do Recibo

Parâmetros
Tipo
Descrição
Obrigatório

email

boolean

Enviar por E-mail

Apenas pode imprimir documentos finalizados/anulados.

email_address

email

Endereço de Destino

email_subject

string

Assunto do E-mail

email_message

string

Mensagem do E-mail

email_cc

email

Endereço cc

email_bcc

email

Endereço bcc

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.

Last updated