> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goatpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar cobranças avulsas

> Lista com paginação e filtros.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/billings/list?page=1&pageSize=50' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Lista de cobranças avulsas",
    "data": {
      "items": [{
        "id": "clx_billing",
        "status": "RECEIVED",
        "statusLabel": "Pago",
        "billingType": "PIX",
        "amount": 79.9,
        "netAmount": 76.91,
        "feeAmount": 2.99,
        "description": "Pedido 123",
        "dueDate": "2026-06-15",
        "createdAt": "2026-05-30T10:00:00.000Z",
        "customer": {
          "id": "clx_customer",
          "name": "Cliente Exemplo",
          "taxId": "12345678909"
        }
      }],
      "page": 1,
      "pageSize": 50,
      "total": 1,
      "pages": 1
    },
    "requestId": "req_abc"
  }
  ```
</ResponseExample>

### Parâmetros de query

<ParamField query="page" type="number">
  Página (padrão 1).
</ParamField>

<ParamField query="pageSize" type="number">
  Itens por página (padrão 50, máx. 100).
</ParamField>

<ParamField query="dateFrom" type="string">
  ISO 8601 — início (`createdAt`).
</ParamField>

<ParamField query="dateTo" type="string">
  ISO 8601 — fim (`createdAt`).
</ParamField>

<ParamField query="status" type="string">
  PENDING, RECEIVED, OVERDUE, CANCELED, REFUNDED ou FAILED.
</ParamField>

<ParamField query="billingType" type="string">
  BOLETO, CREDIT\_CARD, DEBIT\_CARD ou VOUCHER.
</ParamField>

<ParamField query="salesCustomerId" type="string">
  Filtrar por cliente cadastrado.
</ParamField>

<ParamField query="externalReference" type="string">
  Referência externa (transação ledger).
</ParamField>

<ParamField query="search" type="string">
  Busca em id, descrição, externalId da cobrança ou nome do cliente.
</ParamField>


## OpenAPI

````yaml GET /billings/list
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /billings/list:
    get:
      tags:
        - billings
      summary: Listar cobranças avulsas
      operationId: listBillings
      parameters:
        - $ref: '#/components/parameters/ListPage'
        - $ref: '#/components/parameters/ListPageSize'
      responses:
        '200':
          $ref: '#/components/responses/SuccessEnvelope'
components:
  parameters:
    ListPage:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
    ListPageSize:
      name: pageSize
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
  responses:
    SuccessEnvelope:
      description: Operação concluída.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessEnvelope'
          examples:
            default:
              summary: Sucesso
              value:
                success: true
                message: Operação concluída com sucesso
                data: {}
                requestId: req_abc123
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Operação concluída com sucesso
        data:
          type: object
          additionalProperties: true
        requestId:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````