# Lista recebimentos de uma venda

Retorna os recebimentos de uma venda.

Endpoint: GET /api/v3/sales/{saleId}/incomes
Version: 3.0.0
Security: OAuth2

## Path parameters:

  - `saleId` (integer, required)
    Identificador único da venda.

## Response 200 fields (application/json):

  - `data` (object)

  - `data.sale_incomes` (array)
    Representa a lista dos recebimentos.

  - `data.sale_incomes.id` (string)
    Identificador único da movimentação financeira.
    Example: "657870656e73657c3133"

  - `data.sale_incomes.description` (string)
    Descrição da movimentação financeira.
    Example: "Compra de materia de escritório."

  - `data.sale_incomes.notes` (string)
    Notas ou observações sobre a movimentação financeira.
    Example: "Solicitação interna."

  - `data.sale_incomes.competence_date` (string)
    Data de competência da movimentação financeira.
    Example: "2023-05-15"

  - `data.sale_incomes.due_date` (string)
    Data de vencimento da movimentação financeira.
    Example: "2023-05-15"

  - `data.sale_incomes.status` (string)
    Status da movimentação financeira.

Exemplo:

  - unpaid: Em aberta ou não pago
  - partially_paid: Pago parcialmente
  - paid: Pago
    Enum: "unpaid", "partially_paid", "paid"

  - `data.sale_incomes.total` (object)
    Valor total da movimentação financeira.

  - `data.sale_incomes.total.amount` (number, required)
    Valor expresso como um número decimal das principais unidades monetárias
    Example: 99.95

  - `data.sale_incomes.total.currency` (string, required)
    Código de moeda de 3 letras conforme definido pela ISO-4217
    Example: "BRL"

  - `data.sale_incomes.payments` (array)
    Lista de pagamentos associados à movimentação financeira.

  - `data.sale_incomes.payments.payment_method` (object)
    Dados do método de pagamento.

  - `data.sale_incomes.payments.payment_method.id` (integer)
    Identificador do método de pagamento.
    Example: 123

  - `data.sale_incomes.payments.payment_method.name` (string)
    Nome do método de pagamento.
    Example: "Cartão de Crédito"

  - `data.sale_incomes.payments.card_brand` (object)
    Dados da bandeira do cartão.

  - `data.sale_incomes.payments.card_brand.id` (integer)
    Identificador da bandeira do cartão.
    Example: 123

  - `data.sale_incomes.payments.card_brand.name` (string)
    Nome da bandeira do cartão.
    Example: "Visa"

  - `data.sale_incomes.payments.value` (object)
    Valor do pagamento.

  - `data.sale_incomes.payments.payment_date` (string)
    Data do pagamento.
    Example: "2022-01-01"

  - `data.sale_incomes.payments.bank_slip_url` (string)
    URL do boleto.
    Example: "https://cplug.com.br/boleto/123456"

  - `data.sale_incomes.payments.card_receipt` (string)
    Comprovante do pagamento.
    Example: "SITEF\\\\n00001\\\\nBIN\\\\nVIA - ESTABELECI..."

  - `data.sale_incomes.created_at` (string)
    Data da última criação.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.sale_incomes.updated_at` (string)
    Data da última atualização.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.has_devolution` (boolean)
    Indica se a venda tem devolução.

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields