Listar Faturas

Listar Faturas

curl --request GET \
  --url https://api.example.com/invoices \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
      "externalRef": "inv_stripe_abc123",
      "type": "PLAN",
      "paymentMethod": "CARD",
      "card": { "brand": "visa", "last4": "4242", "expMonth": 12, "expYear": 2027 },
      "boleto": null,
      "currency": "BRL",
      "totalAmount": 4900,
      "discountAmount": 0,
      "payableAmount": 4900,
      "discounts": [],
      "lines": [
        { "id": "01HX...", "name": "Starter Plan - Monthly", "unitPrice": 4900, "quantity": 1, "amount": 4900 }
      ],
      "billingThreshold": null,
      "status": "PAID",
      "issuedAt": "2026-03-01T00:00:00.000Z",
      "dueDate": "2026-03-15T00:00:00.000Z",
      "paidAt": "2026-03-01T12:00:00.000Z",
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-01T12:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "totalItems": 200, "totalPages": 10 }
}

GET

invoices

Listar Faturas

curl --request GET \
  --url https://api.example.com/invoices \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
      "externalRef": "inv_stripe_abc123",
      "type": "PLAN",
      "paymentMethod": "CARD",
      "card": { "brand": "visa", "last4": "4242", "expMonth": 12, "expYear": 2027 },
      "boleto": null,
      "currency": "BRL",
      "totalAmount": 4900,
      "discountAmount": 0,
      "payableAmount": 4900,
      "discounts": [],
      "lines": [
        { "id": "01HX...", "name": "Starter Plan - Monthly", "unitPrice": 4900, "quantity": 1, "amount": 4900 }
      ],
      "billingThreshold": null,
      "status": "PAID",
      "issuedAt": "2026-03-01T00:00:00.000Z",
      "dueDate": "2026-03-15T00:00:00.000Z",
      "paidAt": "2026-03-01T12:00:00.000Z",
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-01T12:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "totalItems": 200, "totalPages": 10 }
}

Requer permissao invoice:read.

Headers

Authorization

string

required

Bearer token.

Parametros de Query

page

integer

Numero da pagina.

limit

integer

Resultados por pagina.

organizationId

string

Filtrar por ID da organizacao.

paymentMethod

string

Filter by payment method.

status

string

Filtrar por status.

type

string

Filtrar por tipo.

sortBy

string

Campo de ordenacao.

sortOrder

string

Direcao da ordenacao.

Resposta

data

array

Lista de faturas.

Show propriedades da fatura

invoiceId

string

UUID da fatura.

organizationId

string

UUID da organizacao.

subscriptionId

string

ID da assinatura.

externalRef

string

Referencia externa.

type

string

Tipo da fatura.

paymentMethod

string

Metodo de pagamento.

card

object

Detalhes do cartao (quando o metodo de pagamento e CARD).

boleto

object

Detalhes do boleto (quando o metodo de pagamento e BOLETO).

currency

string

Codigo da moeda.

totalAmount

integer

Valor total em centavos.

discountAmount

integer

Valor de desconto em centavos.

payableAmount

integer

Valor a pagar em centavos.

discounts

array

Descontos aplicados.

lines

array

Itens da fatura.

billingThreshold

object

Limite de faturamento (nullable).

status

string

Status da fatura.

issuedAt

string

Timestamp de emissao.

dueDate

string

Data de vencimento.

paidAt

string

Timestamp de pagamento.

createdAt

string

Timestamp de criacao.

updatedAt

string

Timestamp da ultima atualizacao.

meta

object

Metadados de paginacao.

Show propriedades do meta

page

integer

Numero da pagina atual.

limit

integer

Resultados por pagina.

totalItems

integer

Numero total de itens.

totalPages

integer

Numero total de paginas.

{
  "data": [
    {
      "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
      "externalRef": "inv_stripe_abc123",
      "type": "PLAN",
      "paymentMethod": "CARD",
      "card": { "brand": "visa", "last4": "4242", "expMonth": 12, "expYear": 2027 },
      "boleto": null,
      "currency": "BRL",
      "totalAmount": 4900,
      "discountAmount": 0,
      "payableAmount": 4900,
      "discounts": [],
      "lines": [
        { "id": "01HX...", "name": "Starter Plan - Monthly", "unitPrice": 4900, "quantity": 1, "amount": 4900 }
      ],
      "billingThreshold": null,
      "status": "PAID",
      "issuedAt": "2026-03-01T00:00:00.000Z",
      "dueDate": "2026-03-15T00:00:00.000Z",
      "paidAt": "2026-03-01T12:00:00.000Z",
      "createdAt": "2026-03-01T00:00:00.000Z",
      "updatedAt": "2026-03-01T12:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "totalItems": 200, "totalPages": 10 }
}

Exemplos de Codigo

curl https://api.awsales.io/admin/invoices?page=1&limit=20 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Codigos de Erro

Status	Codigo	Descricao
`400`	`validation_error`	Entrada invalida ou campos obrigatorios ausentes
`401`	`unauthorized`	Autenticacao ausente ou invalida
`403`	`forbidden`	Permissoes insuficientes
`500`	`internal_server_error`	Ocorreu um erro inesperado

O Objeto Fatura

Buscar Fatura

⌘I

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

Headers

Parametros de Query

Resposta

Exemplos de Codigo

Codigos de Erro

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

​Headers

​Parametros de Query

​Resposta

​Exemplos de Codigo

​Codigos de Erro

Headers

Parametros de Query

Resposta

Exemplos de Codigo

Codigos de Erro