Campo

Tipo

Descrição

Exemplo

event_type

string

Tipo de evento

"invoice-finalize"

date

número (timestamp)

Timestamp de quando o evento foi acionado

1762246989

data

Objeto

Detalhes sobre o evento e a fatura (ver abaixo).

-

data.date

"2025-11-04T09:03:11.653072Z"

data.object.id

string (uuid)

Identificador único da fatura

"923e2c97-8228-4d42-8a44-1783c70c50a1"

data.object.object

string

Tipo de objeto (sempre invoice).

"invoice"

data.object.status

string

Estado da fatura (open, paid, refunded, voided).

"open"

data.object.date_created

string (date-time)

Quando a fatura foi criada (UTC).

"2025-11-04T09:03:06.515219Z"

data.object.date_created

string (date-time)

Quando a fatura foi criada (UTC).

"2025-11-04T09:03:06.515219Z"

data.object.date_issued

string (date-time)

Quando a fatura foi emitida (UTC).

"2025-11-04T09:03:08.225042Z"

data.object.date_due

string (date-time)

Data de vencimento do pagamento (UTC).

"2025-11-04T09:03:07.292000Z"

data.object.date_cancelled

string (date-time) | null

Quando a fatura foi cancelada (se aplicável).

null

data.object.currency

string

Moeda da fatura (código ISO 4217).

"eur"

data.object.total

número (cêntimos)

Valor total da fatura na unidade mais pequena (por exemplo, cêntimos).

36665

data.object.amount_due

número (cêntimos)

Valor em dívida na unidade mais pequena (por exemplo, cêntimos).

36665

data.object.amount_paid

número (cêntimos)

Valor já pago na unidade mais pequena (por exemplo, cêntimos).

0

data.object.company

objeto

Empresa que emite a fatura.

{ ... }

data.object.company.id

número

ID único da empresa. Para saberes o ID da tua empresa, acede a esta página do backoffice página.

85329

data.object.company.name

string

Nome da empresa.

"SaudeViva Portugal"

data.object.company.country

string

Código do país.

"PT"

data.object.company.city

string

Cidade.

"Lisbon"

data.object.company.address

string

Morada.

"Rua do Ouro 115"

data.object.company.postal_code

string

Código postal.

"1100-062"

data.object.customer

objeto | null

Cliente a quem é emitida a fatura (pode ser null para faturas anónimas de Ponto de Venda).

{ ... }

data.object.customer.id

número

ID único do cliente/membro.

7644312

data.object.customer.type

string

Tipo de cliente (sempre individual neste caso).

"individual"

data.object.customer.name

string

Nome completo.

"Maria Oliveira"

data.object.customer.first_name

string

Primeiro nome.

"Maria"

data.object.customer.last_name

string

Apelido.

"Oliveira"

data.object.customer.email

string

E-mail de contacto.

"maria.oliveira77@example.com"

data.object.customer.phone

string

Número de telefone.

"+351 912 345 678"

data.object.customer.official_document_id

string

Documento oficial/nacional (pode ser o NIF).

"PT-19847765"

data.object.customer.address

objeto

Morada do cliente.

{ ... }

data.object.customer.address.line1

string

Morada (rua).

"Avenida da Liberdade 202"

data.object.customer.address.line2

string (opcional)

Informação adicional da morada.

"4º Esq."

data.object.customer.address.city

string

Cidade.

"Lisbon"

data.object.customer.address.postal_code

string

Código postal.

"1250-147"

data.object.customer.address.state

string

Estado/região.

"Lisboa"

data.object.customer.address.country

string

Código do país.

"PT"

data.object.line_items

objeto

Contentor das linhas de fatura.

{ ... }

data.object.line_items.line_count

número

Número de linhas de fatura.

6

data.object.line_items.data

array<objeto>

Array de linhas de fatura.

[{ ... }, { ... }]

data.object.line_items.data[].id

número

Identificador único da linha de fatura.

2153

data.object.line_items.data[].description

string

Nome/etiqueta do produto ou serviço.

"£100 General Gift Voucher"

data.object.line_items.data[].quantity

número

Número de unidades adquiridas.

1

data.object.line_items.data[].tax_included_unit_amount

número (cêntimos)

Preço unitário com imposto incluído, em cêntimos.

10000

data.object.line_items.data[].tax_included_amount

número (cêntimos)

Preço total com imposto incluído antes do desconto (quantity * unit_amount).

10000

data.object.line_items.data[].voucher_applied

número (cêntimos)

Desconto/voucher aplicado a esta linha, em cêntimos.

0

data.object.line_items.data[].line_total

número (cêntimos)

Valor final da linha após o desconto, em cêntimos.

10000

data.object.line_items.data[].tax_breakdown

objeto

Detalhes do cálculo do imposto.

{ ... }

data.object.line_items.data[].tax_breakdown.rate

número (%)

Percentagem da taxa de imposto (por exemplo, 20 = 20%).

0

data.object.line_items.data[].tax_breakdown.total_tax

número (cêntimos)

Imposto total incluído nesta linha, em cêntimos.

0

data.object.line_items.data[].tax_breakdown.unit_tax

número (cêntimos)

Imposto incluído por unidade, em cêntimos.

0

data.object.line_items.data[].item_type

string

Tipo de artigo bsport (shop-product, pass, private_pass, consumer_giftcard, refund).

"consumer_giftcard"

data.object.invoice_pdf

string (url)

Link para o PDF da fatura.

"https://assets.staging.bsport.io/.../invoice-24092226.pdf"

data.object.receipt_pdf

string (url) | null

Link para o PDF do recibo de pagamento (se aplicável).

null

data.object.invoice_type

número

Tipo de fatura: 0=normal, 1=reversão, 2=nota de crédito, 3=migração.

0

data.object.source_invoice_id

string (uuid) | null

UUID da fatura original cancelada através desta (se aplicável).

null