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

# Obter Conta a Pagar

> Serviço destinado a obter informações sobre contas a pagar.

## Endpoint

```
POST https://api.tiny.com.br/api2/conta.pagar.obter.php
```

## Parâmetros

| Parâmetro | Tipo   | Ocorrência  | Descrição                                 |
| --------- | ------ | ----------- | ----------------------------------------- |
| token     | string | obrigatório | Chave gerada para identificar sua empresa |
| id        | int    | obrigatório | Número de identificação da conta a pagar  |
| formato   | string | obrigatório | Formato do retorno (json)                 |

## Retorno

| Campo                                 | Tipo    | Tamanho | Ocorrência  | Descrição                                 |
| ------------------------------------- | ------- | ------- | ----------- | ----------------------------------------- |
| retorno                               | object  | -       | obrigatório | Elemento raiz do retorno                  |
| retorno.status\_processamento         | int     | -       | obrigatório | Conforme tabela "Status de Processamento" |
| retorno.status                        | string  | -       | obrigatório | "OK" ou "Erro"                            |
| retorno.codigo\_erro                  | int     | -       | condicional | Conforme tabela "Códigos de erro" (1)     |
| retorno.erros\[]                      | list    | -       | condicional | Lista dos erros encontrados \[0..n] (1)   |
| retorno.erros\[].erro                 | string  | -       | condicional | Descrição do erro (1)                     |
| retorno.conta                         | object  | -       | condicional | Dados da conta a pagar (2)                |
| retorno.conta.id                      | int     | -       | obrigatório | ID da conta a pagar                       |
| retorno.conta.data                    | date    | 10      | obrigatório | Data de emissão (dd/mm/yyyy)              |
| retorno.conta.vencimento              | date    | 10      | obrigatório | Data de vencimento (dd/mm/yyyy)           |
| retorno.conta.valor                   | decimal | -       | obrigatório | Valor da conta                            |
| retorno.conta.saldo                   | decimal | -       | obrigatório | Saldo da conta                            |
| retorno.conta.nro\_documento          | string  | 30      | opcional    | Número do documento                       |
| retorno.conta.competencia             | date    | 7       | opcional    | Competência da conta                      |
| retorno.conta.historico               | string  | 300     | opcional    | Histórico da conta                        |
| retorno.conta.categoria               | string  | 100     | opcional    | Categoria da conta                        |
| retorno.conta.situacao                | string  | 50      | opcional    | Situação (aberto/pago/cancelada/parcial)  |
| retorno.conta.ocorrencia              | string  | 1       | obrigatório | Tipo: U/P/W/M/T/S/A (3)                   |
| retorno.conta.dia\_vencimento         | int     | 2       | opcional    | Dia de vencimento (4)                     |
| retorno.conta.numero\_parcelas        | int     | 3       | opcional    | Número de parcelas                        |
| retorno.conta.dia\_semana\_vencimento | int     | 1       | opcional    | Dia semanal (0-6) (5)                     |
| retorno.conta.cliente                 | object  | -       | obrigatório | Dados do cliente                          |
| retorno.conta.cliente.codigo          | string  | 30      | opcional    | Código do cliente                         |
| retorno.conta.cliente.nome            | string  | 50      | obrigatório | Nome do cliente                           |
| retorno.conta.cliente.tipo\_pessoa    | string  | 1       | opcional    | Tipo (F/J/E)                              |
| retorno.conta.cliente.cpf\_cnpj       | string  | 18      | opcional    | CPF ou CNPJ                               |
| retorno.conta.cliente.ie              | string  | 18      | opcional    | Inscrição estadual                        |
| retorno.conta.cliente.rg              | string  | 10      | opcional    | RG                                        |
| retorno.conta.cliente.endereco        | string  | 50      | opcional    | Endereço                                  |
| retorno.conta.cliente.numero          | string  | 10      | opcional    | Número do endereço                        |
| retorno.conta.cliente.complemento     | string  | 50      | opcional    | Complemento                               |
| retorno.conta.cliente.bairro          | string  | 30      | opcional    | Bairro                                    |
| retorno.conta.cliente.cep             | string  | 10      | opcional    | CEP                                       |
| retorno.conta.cliente.cidade          | string  | 30      | opcional    | Cidade                                    |
| retorno.conta.cliente.uf              | string  | 2       | opcional    | UF                                        |
| retorno.conta.cliente.pais            | string  | 50      | opcional    | País                                      |
| retorno.conta.cliente.fone            | string  | 40      | opcional    | Telefone                                  |
| retorno.conta.cliente.email           | string  | 50      | opcional    | Email                                     |

> (1) Erros e código de erro aparecem apenas quando status for "Erro"

> (2) Dados da conta aparecem apenas quando status for "OK"

> (3) Ocorrência: U (única), P (parcelada), W (semanal), M (mensal), T (trimestral), S (semestral), A (anual)

> (4) Campo dia\_vencimento é obrigatório quando ocorrência for "M" (mensal) ou "P" (parcelada)

> (5) Campo dia\_semana\_vencimento retorna apenas quando ocorrência for "W" (semanal), com valores 0-6 representando domingo a sábado

## Exemplo de chamada

```bash theme={null}
curl -X POST https://api.tiny.com.br/api2/conta.pagar.obter.php \
  -d "token=SEU_TOKEN&id=12341234&formato=json"
```

## Exemplos de retorno

### Erro - Token inválido

```json theme={null}
{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}
```

### Erro - Conta não localizada

```json theme={null}
{
  "retorno": {
    "status_processamento": "2",
    "status": "Erro",
    "codigo_erro": "32",
    "erros": [
      {
        "erro": "Conta a pagar não localizada"
      }
    ]
  }
}
```

### Sucesso

```json theme={null}
{
  "retorno": {
    "status_processamento": "3",
    "status": "OK",
    "conta": {
      "id": "433224432",
      "data": "25/11/2015",
      "vencimento": "28/10/2016",
      "valor": "6565.00",
      "nro_documento": "000065205",
      "competencia": "10/2016",
      "cliente": {
        "codigo": "",
        "nome": "Henrique Teste 4100",
        "tipo_pessoa": "J",
        "cpf_cnpj": "54.544.826/0001-40",
        "ie": "ISENTO",
        "rg": "",
        "endereco": "afdsafsd",
        "numero": "2123",
        "complemento": "213213",
        "bairro": "bababa",
        "cep": "15.200-000",
        "cidade": "José Bonifácio",
        "uf": "SP",
        "pais": null,
        "fone": "",
        "email": ""
      },
      "historico": "historico - mensal - henrique teste 4100",
      "categoria": "Telecomunicação, internet",
      "situacao": "aberto",
      "ocorrencia": "M",
      "dia_vencimento": "28"
    }
  }
}
```

## Observações

* Datas utilizam formato dd/mm/yyyy
* Valores decimais usam "." (ponto) como separador