Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
contaobjectobrigatórioDados da conta conforme layout
formatostringobrigatórioFormato do retorno (json)

​
Layout do parâmetro “conta”

CampoTipoTamanhoOcorrênciaDescrição
conta.idint-obrigatórioIdentificador da conta a pagar
conta.contaOrigemstring100opcionalNome da conta origem da baixa (1)
conta.datadate10opcionalData de baixa da conta a pagar (formato dd/mm/yyyy) (1)
conta.categoriastring100opcionalNome da categoria (1)
conta.historicostring300opcionalHistórico da conta a pagar (1)
conta.valorTaxasdecimal-opcionalValor de taxas (2)
conta.valorJurosdecimal-opcionalValor de juros (2)
conta.valorDescontodecimal-opcionalValor de desconto (2)
conta.valorAcrescimodecimal-opcionalValor de acréscimo (2)
conta.valorPagodecimal-opcionalValor pago da conta a pagar (1)
(1) Se não informados, serão considerados valores cadastrados na conta
(2) Se não informados, será considerado valor 0

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-obrigatórioConforme tabela “Códigos de erro”
retorno.erros[]list-condicionalLista dos erros encontrados [0..n]
retorno.erros[].errostring-condicionalDescrição do erro
retorno.registros[]list-condicionalLista de resultados
retorno.registros[].registro.sequenciaint-condicionalNúmero sequencial
retorno.registros[].registro.statusstring-condicional”OK” ou “Erro”
retorno.registros[].registro.codigo_erroint-condicionalCódigo do erro
retorno.registros[].registro.erros[]list-condicionalLista de erros [0..n]
retorno.registros[].registro.erros[].errostring-condicionalDescrição do erro
retorno.registros[].registro.idint-condicionalID da conta a pagar

​
Observações

  • Datas devem ser formatadas como dd/mm/yyyy (exemplo: “01/01/2012”)
  • Valores decimais usam ”.” (ponto) como separador (exemplo: “5.25”)
  • Apenas contas em aberto podem ser baixadas

​
Exemplo de parâmetro

{
  "conta": {
    "id": "350187089",
    "contaOrigem": "Bradesco",
    "data": "10/10/2016",
    "categoria": "Água, Luz",
    "historico": "historico de teste",
    "valorTaxas": 4.3,
    "valorJuros": 3.5,
    "valorDesconto": 6.4,
    "valorAcrescimo": 3.3,
    "valorPago": 35.50
  }
}

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/conta.pagar.baixar.php \
  -d 'token=SEU_TOKEN&formato=json&conta={...}'

​
Exemplos de retorno

​
Erro - Token inválido

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}

​
Erro - Conta já paga

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "31",
          "erros": [
            {
              "erro": "Essa conta já foi paga."
            }
          ]
        }
      }
    ]
  }
}

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "OK",
          "id": "49644545"
        }
      }
    ]
  }
}