A API V3 JÁ ESTÁ DISPONÍVEL
As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente. |
Insere um RPS de uma nota de serviço
Insere um RPS de uma nota de serviço no sistema
curl | curl -X POST "https://www.bling.com.br/Api/v2/notaservico/json/" -d "apikey={apikey}" -d "xml={xml_da_nota}" |
PHP |
$url = 'https://www.bling.com.br/Api/v2/notaservico/json/'; |
C# |
public static void Execute() { |
Parâmetro | Descrição | Tipo |
apikey |
apikey gerada no sistema | string |
xml |
xml contendo os dados para o RPS da nota de serviço | string |
Para o parâmetro xml
, é necessário seguir um padrão.
Tabela de campos do XML
Grupo | Campo | Informação | Tipo | Padrão | Opcional | Nota |
---|---|---|---|---|---|---|
raiz | pedido | Obrigatório | ||||
pedido | data | Data de emissão | STRING | dd/mm/aaaa | Opcional | |
pedido | vendedor | Nome do vendedor cadastrado no sistema | STRING | Opcional | ||
pedido | numero_rps | Número do RPS | STRING(6) | Opcional | ||
pedido | reter_iss | Reter ISS | STRING(1) | S ou N | Opcional | |
pedido | desconto | Valor do desconto do pedido | DECIMAL(11,2) | 999,99 | Opcional | |
pedido | cliente | Grupo de informações do cliente | Obrigatório | |||
cliente | nome | Nome do Cliente | STRING(80) | Obrigatório | ||
cliente | cnpj | CNPJ do cliente | STRING(18) | 99999999999999 | Obrigatório | |
cliente | ie | Inscrição Estadual | STRING(18) | 9999999999 | Obrigatório caso possua | |
cliente | im | Inscrição Municipal | STRING(18) | Opcional | ||
cliente | endereco | Endereço do Cliente | STRING(100) | Obrigatório | ||
cliente | numero | Número da casa do cliente | STRING(10) | Obrigatório | ||
cliente | complemento | Complemento do endereço do cliente | STRING(100) | Opcional | ||
cliente | bairro | Bairro do cliente | STRING(40) | Obrigatório | ||
cliente | cep | CEP do cliente | STRING(10) | 99.999-999 | Obrigatório | |
cliente | cidade | Cidade do cliente | STRING(30) | Obrigatório | ||
cliente | uf | Sigla do estado do cliente | STRING(2) | Obrigatório | ||
cliente | fone | Telefone do cliente | STRING(40) | Opcional | ||
cliente | E-mail do cliente | STRING(80) | Obrigatório | |||
pedido | servicos | Grupo de serviços | Obrigatório | |||
servicos | servico | Grupo de informações do serviço | Obrigatório | |||
servico | descricao | Descrição do serviço | STRING | Obrigatório | ||
servico | valor | Valor do serviço | DECIMAL(11,2) | 999,99 | Obrigatório | |
servico | codigo | Código da lista de serviços | STRING(8) | Obrigatório | ||
pedido | parcelas | Grupo de parcelas | Opcional | |||
parcelas | parcela | Grupo de informações da parcela | Obrigatório | |||
parcela | dias | Dias de vencimento da parcela após data de emissão | INTEGER | Opcional | ||
parcela | data | Data de vencimento da parcela | STRING | Opcional | ||
parcela | vlr | Valor da parcela | DECIMAL(11,2) | 999,99 | Obrigatório | |
parcela | obs | Observação da parcela | STRING | Opcional | ||
parcela | forma | Forma de pagamento da parcela | STRING | Opcional |
Mensagens de erros específicos
Código | Mensagem |
---|---|
50 | UF do cliente inválida. Utilize sigla de duas letras. |
55 | Ja existe uma nota de serviço cadastrada com este XML. |
59 | Ha itens sem descricao. Este parametro e obrigatorio. |
60 | O valor da primeira parcela é menor do que o valor dos impostos descontados. Quando há impostos descontáveis, o valor será abatido da primeira parcela. |
61 | Informe apenas uma das informações de parcela: data ou dias. |
68 |
Forma de pagamento nao encontrada. |
Exemplo do XML
<?xml version="1.0" encoding="UTF-8"?>
<pedido>
28/07/2017
<cliente>
<nome>Organisys Software</nome>
<cnpj>00000000000000</cnpj>
<ie>3067663000</ie>
<endereco>Rua Visconde de São Gabriel</endereco>
<numero>392</numero>
<complemento>Sala 54</complemento>
<bairro>Cidade Alta</bairro>
<cep>95.700-000</cep>
<cidade>Bento Gonçalves</cidade>
<uf>RS</uf>
<fone>54 8115-3376</fone>
<email>teste@teste.com.br</email>
</cliente>
<servicos>
<servico>
<codigo>1.03.01</codigo>
<descricao>Desenvolvimento de site</descricao>
<valor>1678,14</valor>
</servico>
</servicos>
<parcelas>
<parcela>
<dias>30</dias>
<vlr>1678,14</vlr>
<obs>Parcela 1</obs>
</parcela>
</parcelas>
</pedido>
Retorno
Em caso de sucesso, retornará o número do RPS, no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.
A resposta será no formato especificado na URL (XML ou JSON).
Exemplo de retorno
{
"retorno": {
"notasservico": [
{
"notaservico": {
"numero": "000003"
}
}
]
}
}