Alterar Conta a Receber API 2.0
Serviço destinado a alteração de Contas a Receber.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| formato | string | obrigatório | Formato do retorno (json) |
Conteúdo do body
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| conta (1) | object | obrigatório | Dados da conta conforme layout |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| conta | object | - | obrigatório | Elemento utilizado para representar uma conta a receber |
| conta.id (1) | int | 10 | obrigatório | Código da Conta a Receber |
| conta.vencimento (2) | date | 10 | obrigatório | Vencimento da conta a receber |
| conta.taxa (3) | decimal | - | opcional | Taxa da conta a receber |
| conta.competencia(4) | date | 7 | opcional | Competência da conta a receber |
| conta.categoria (5) | string | 100 | opcional | Nome da categoria |
(1) - Este campo é o identificador unico da conta a receber no sistema.
(2) - Este campo deve ser informado no formato dd/mm/yyyy, exemplo "01/01/2012".
(3) - Este campo utiliza “.” (ponto) como separador de decimais, exemplo "5.25". A taxa será considerada/permitida somente se a forma de recebimento for cartão de crédito, cartão de débito ou personalizada.
(4) - Este campo deve ser informado no formato "mm/aaaa", exemplo "05/2022"
(5) - Este campo é utilizado para pesquisar a categoria. Caso nenhum resultado seja retornado, a categoria ficará vazia.
Retorno do serviço
| Elemento | 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 | Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
| retorno.codigo_erro (1) | int | - | obrigatório | Conforme tabela "Códigos de erro" |
| retorno.erros[ ] (1) (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
| retorno.erros[ ],erro | string | - | condicional | Mensagem contendo a descrição do erro |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja diferente de "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
