Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/conta.receber.alterar.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.idint10obrigatórioCódigo da conta a receber (identificador único)
conta.vencimentodate10obrigatórioVencimento da conta a receber (formato dd/mm/yyyy)
conta.taxadecimal-opcionalTaxa da conta a receber (1)
conta.competenciadate7opcionalCompetência da conta a receber (formato mm/aaaa)
conta.categoriastring100opcionalNome da categoria
(1) Taxa permitida apenas para cartão crédito, débito ou forma personalizada

​
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-condicionalConforme tabela “Códigos de erro” (2)
retorno.erros[]list-condicionalLista dos erros encontrados [0..n] (2)
retorno.erros[].errostring-condicionalDescrição do erro (2)
(2) Campos de erro aparecem apenas quando status = “Erro”

​
Observações

  • Apenas contas em aberto podem ser alteradas
  • Data de vencimento deve estar em formato válido (dd/mm/yyyy)
  • Competência deve estar no formato mm/aaaa
  • Valores decimais usam ponto (.) como separador

​
Exemplo de parâmetro

{
  "conta": {
    "id": "123",
    "vencimento": "01/12/2022",
    "taxa": 25.50,
    "competencia": "12/2022",
    "categoria": "impostos"
  }
}

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/conta.receber.alterar.php \
  -d 'token=SEU_TOKEN&formato=json&conta={
    "id": "123",
    "vencimento": "01/12/2022",
    "taxa": 25.50,
    "competencia": "12/2022",
    "categoria": "impostos"
  }'

​
Exemplos de retorno

​
Erro - Token inválido

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

​
Erro - Validação

{
  "retorno": {
    "status_processamento": "2",
    "status": "Erro",
    "codigo_erro": 31,
    "erros": [
      {
        "erro": "vencimento",
        "campo": "O campo vencimento deve ser uma data válida."
      },
      {
        "erro": "situacao",
        "campo": "Somente é possivel alterar uma conta em aberto."
      }
    ]
  }
}

​
Sucesso

{
  "retorno": {
    "status_processamento": "3",
    "status": "OK"
  }
}