Skip to main content
A fatura da loja é o objeto devolvido por GET /{partnerId}/invoices e GET /{partnerId}/merchants/invoices. O resumo por revenda tem formato próprio, descrito em Listando faturas das revendas.

​
Objeto

​
uuid
ID da loja.
​
uuid
ID da revenda. Veja resaleId.
​
uuid
Plano da assinatura no fechamento.
​
string | integer
Mês da fatura. Repete o valor enviado na query (texto, ex.: "4"); sem o parâmetro, vem como número.
​
string | integer
Ano da fatura, com a mesma regra de month.
​
object[]
Totais da fatura, um bloco por tipo. Veja totalPrice.
​
object[]
Detalhamento por recurso.

​
resaleId

Só aparece quando o partnerId consultado é um parceiro e a loja pertence a uma revenda. Consultando com o ID de uma revenda, o campo é omitido: todas as lojas da resposta são daquela revenda.

​
totalPrice

Cada bloco tem um type:
  • PAYABLE: o que você paga pela loja. Para o parceiro, o custo junto à DeliveryVip. Para a revenda, o que ela paga ao parceiro.
  • RECEIVABLE: o que você recebe, pela sua tabela de preços. Para o parceiro, o preço cobrado da loja direta ou da revenda. Para a revenda, o preço cobrado da loja.
RECEIVABLE só é enviado quando a tabela de preços de recebíveis está habilitada para o parceiro. Sem ela, os arrays trazem só PAYABLE. Consultando como revenda sem essa tabela, a fatura não traz totalPrice e os itens vêm sem preço. Nunca acesse os blocos pela posição (totalPrice[1]): procure pelo campo type.

​
value e usageTimeValue

value é o valor do mês cheio, como se a assinatura da loja tivesse ficado ativa o mês inteiro. usageTimeValue é proporcional ao tempo em que a assinatura ficou ativa no mês, contado em dias, da ativação (ou do início do mês) até o cancelamento (ou o fim do mês). Uma loja ativada no dia 16 de um mês de 30 dias tem usageTimeValue igual à metade do value. Quando a assinatura fica ativa o mês inteiro, os dois são iguais. Os dois usam até 4 casas decimais.

​
Tipos de item

GROWTH_DISCOUNT, INTEGRATION_MARKETING e INTEGRATION_LOGISTIC aparecem com quantidade 1 quando o recurso está incluso no plano ou foi contratado à parte.