Nibo Empresas API

API change history

H - Listar NFS-e v2

Try it

Solicitação

Solicitar URL

Parâmetros de solicitação

  • (opcional)
    string

Corpo da solicitação

Respostas

200 OK

Representações

{
  "Id": "string",
  "Status": {
    "Code": 0,
    "Description": "string"
  },
  "LastMessage": "string",
  "LastStatusMessage": "string",
  "LastStatusChange": "string",
  "Schedule": {
    "Id": {},
    "DueDate": "string",
    "ScheduleDate": "string",
    "Value": 0,
    "Description": "string",
    "IsDeleted": true
  },
  "RpsNumber": {},
  "RpsSeries": "string",
  "AccrualRpsDate": {},
  "VerificationCode": "string",
  "Number": "string",
  "AuthorizeDate": {},
  "CancelDate": {},
  "CreateDate": "string",
  "CreateUser": "string",
  "UpdateDate": {},
  "UpdateUser": "string",
  "PdfFileId": {},
  "PdfFileUrl": {},
  "XmlFileId": {},
  "XmlFileUrl": {},
  "Remarks": "string",
  "Deductions": 0,
  "Discounts": 0,
  "Value": 0,
  "ServiceProfile": {
    "Id": "string",
    "Name": "string",
    "IsDeleted": true
  },
  "Customer": {
    "CpfCnpj": "string",
    "Email": "string",
    "LegalType": "string",
    "Name": "string",
    "Phone": "string",
    "Address": {
      "UF": "string",
      "City": "string",
      "PostalCode": "string",
      "District": "string",
      "Complement": "string",
      "Address": "string",
      "Number": "string"
    }
  },
  "Service": {
    "Description": "string",
    "OperationType": "string",
    "CityServiceCode": "string",
    "CNAECode": "string",
    "ServiceListItemLC116": "string",
    "RemoveISSValueFromBaseValueToCalculatePISAndCOFINS": true,
    "ISS": {
      "Aliquot": 0,
      "Retained": true,
      "Value": 0
    },
    "PIS": {
      "ReductionBase": 0,
      "Aliquot": 0,
      "Retained": true,
      "Value": 0
    },
    "COFINS": {
      "ReductionBase": 0,
      "Aliquot": 0,
      "Retained": true,
      "Value": 0
    },
    "CSLL": {
      "Aliquot": 0,
      "Retained": true,
      "Value": 0
    },
    "IR": {
      "Aliquot": 0,
      "Retained": true,
      "Value": 0
    },
    "INSS": {
      "ReductionBase": 0,
      "Aliquot": 0,
      "Retained": true,
      "Value": 0
    },
    "FederalTax": {
      "Aliquot": 0,
      "Value": 0
    },
    "PISAndCOFINSTaxSituation": {}
  },
  "Stakeholder": {
    "Key": "string",
    "Name": "string"
  }
}
{
  "type": "object",
  "properties": {
    "Id": {
      "type": "string"
    },
    "Status": {
      "type": "object",
      "properties": {
        "Code": {
          "type": "integer"
        },
        "Description": {
          "type": "string"
        }
      }
    },
    "LastMessage": {
      "type": "string"
    },
    "LastStatusMessage": {
      "type": "string"
    },
    "LastStatusChange": {
      "type": "string"
    },
    "Schedule": {
      "type": "object",
      "properties": {
        "Id": {},
        "DueDate": {
          "type": "string"
        },
        "ScheduleDate": {
          "type": "string"
        },
        "Value": {
          "type": "integer"
        },
        "Description": {
          "type": "string"
        },
        "IsDeleted": {
          "type": "boolean"
        }
      }
    },
    "RpsNumber": {},
    "RpsSeries": {
      "type": "string"
    },
    "AccrualRpsDate": {},
    "VerificationCode": {
      "type": "string"
    },
    "Number": {
      "type": "string"
    },
    "AuthorizeDate": {},
    "CancelDate": {},
    "CreateDate": {
      "type": "string"
    },
    "CreateUser": {
      "type": "string"
    },
    "UpdateDate": {},
    "UpdateUser": {
      "type": "string"
    },
    "PdfFileId": {},
    "PdfFileUrl": {},
    "XmlFileId": {},
    "XmlFileUrl": {},
    "Remarks": {
      "type": "string"
    },
    "Deductions": {
      "type": "integer"
    },
    "Discounts": {
      "type": "integer"
    },
    "Value": {
      "type": "integer"
    },
    "ServiceProfile": {
      "type": "object",
      "properties": {
        "Id": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "IsDeleted": {
          "type": "boolean"
        }
      }
    },
    "Customer": {
      "type": "object",
      "properties": {
        "CpfCnpj": {
          "type": "string"
        },
        "Email": {
          "type": "string"
        },
        "LegalType": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        },
        "Phone": {
          "type": "string"
        },
        "Address": {
          "type": "object",
          "properties": {
            "UF": {
              "type": "string"
            },
            "City": {
              "type": "string"
            },
            "PostalCode": {
              "type": "string"
            },
            "District": {
              "type": "string"
            },
            "Complement": {
              "type": "string"
            },
            "Address": {
              "type": "string"
            },
            "Number": {
              "type": "string"
            }
          }
        }
      }
    },
    "Service": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string"
        },
        "OperationType": {
          "type": "string"
        },
        "CityServiceCode": {
          "type": "string"
        },
        "CNAECode": {
          "type": "string"
        },
        "ServiceListItemLC116": {
          "type": "string"
        },
        "RemoveISSValueFromBaseValueToCalculatePISAndCOFINS": {
          "type": "boolean"
        },
        "ISS": {
          "type": "object",
          "properties": {
            "Aliquot": {
              "type": "integer"
            },
            "Retained": {
              "type": "boolean"
            },
            "Value": {
              "type": "integer"
            }
          }
        },
        "PIS": {
          "type": "object",
          "properties": {
            "ReductionBase": {
              "type": "integer"
            },
            "Aliquot": {
              "type": "integer"
            },
            "Retained": {
              "type": "boolean"
            },
            "Value": {
              "type": "integer"
            }
          }
        },
        "COFINS": {
          "type": "object",
          "properties": {
            "ReductionBase": {
              "type": "integer"
            },
            "Aliquot": {
              "type": "integer"
            },
            "Retained": {
              "type": "boolean"
            },
            "Value": {
              "type": "integer"
            }
          }
        },
        "CSLL": {
          "type": "object",
          "properties": {
            "Aliquot": {
              "type": "integer"
            },
            "Retained": {
              "type": "boolean"
            },
            "Value": {
              "type": "integer"
            }
          }
        },
        "IR": {
          "type": "object",
          "properties": {
            "Aliquot": {
              "type": "integer"
            },
            "Retained": {
              "type": "boolean"
            },
            "Value": {
              "type": "integer"
            }
          }
        },
        "INSS": {
          "type": "object",
          "properties": {
            "ReductionBase": {
              "type": "integer"
            },
            "Aliquot": {
              "type": "integer"
            },
            "Retained": {
              "type": "boolean"
            },
            "Value": {
              "type": "integer"
            }
          }
        },
        "FederalTax": {
          "type": "object",
          "properties": {
            "Aliquot": {
              "type": "integer"
            },
            "Value": {
              "type": "integer"
            }
          }
        },
        "PISAndCOFINSTaxSituation": {}
      }
    },
    "Stakeholder": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string"
        },
        "Name": {
          "type": "string"
        }
      }
    }
  }
}

Exemplos de código

@ECHO OFF

curl -v -X GET "https://api.nibo.com.br/empresas/v1/nfse?Organization={string}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);


            // Request parameters
            queryString["Organization"] = "{string}";
            var uri = "https://api.nibo.com.br/empresas/v1/nfse?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.nibo.com.br/empresas/v1/nfse");

            builder.setParameter("Organization", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "Organization": "{string}",
        };
      
        $.ajax({
            url: "https://api.nibo.com.br/empresas/v1/nfse?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.nibo.com.br/empresas/v1/nfse";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"Organization={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.nibo.com.br/empresas/v1/nfse');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'Organization' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
}

params = urllib.urlencode({
    # Request parameters
    'Organization': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.nibo.com.br')
    conn.request("GET", "/empresas/v1/nfse?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
}

params = urllib.parse.urlencode({
    # Request parameters
    'Organization': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.nibo.com.br')
    conn.request("GET", "/empresas/v1/nfse?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.nibo.com.br/empresas/v1/nfse')

query = URI.encode_www_form({
    # Request parameters
    'Organization' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body