API-v2

Application Programming Interface

InvoiceXpress Documentation



Export SAF-T


GET /api/export_saft.json

Generates the SAF-T file for a specific date (month and year). The first response given will have a HTTP 202 code, meaning the generation was started. You need to keep requesting until you get a response with HTTP status code 200, and the url to download the file in the message body.

Example Request

curl

curl --request GET \
  --url 'https://account_name.app.invoicexpress.com/api/export_saft.json?month=10&years=2017&api_key=YOUR%20API%20KEY%20HERE' \
  --header 'accept: application/json'

Ruby

require 'uri'
require 'net/http'

url = URI("https://account_name.app.invoicexpress.com/api/export_saft.json?month=10&years=2017&api_key=YOUR%20API%20KEY%20HERE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'

response = http.request(request)
puts response.read_body

Node

var http = require("https");

var options = {
  "method": "GET",
  "hostname": "account_name.app.invoicexpress.com",
  "port": null,
  "path": "/api/export_saft.json?month=10&years=2017&api_key=YOUR%20API%20KEY%20HERE",
  "headers": {
    "accept": "application/json"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Python

import http.client

conn = http.client.HTTPSConnection("account_name.app.invoicexpress.com")

headers = { 'accept': "application/json" }

conn.request("GET", "/api/export_saft.json?month=10&years=2017&api_key=YOUR%20API%20KEY%20HERE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://account_name.app.invoicexpress.com/api/export_saft.json?month=10&years=2017&api_key=YOUR%20API%20KEY%20HERE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://account_name.app.invoicexpress.com/api/export_saft.json?month=10&years=2017&api_key=YOUR%20API%20KEY%20HERE"

    req, _ := http.NewRequest("GET", url, nil)

    req.Header.Add("accept", "application/json")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}

Queruy Parameters

Name Type Required Description Example
month String Required The month for which you want to generate the SAF-T. 10
year String Required The year for which you want to generate the SAF-T. 2017

Responses

200 DOWNLOAD SAF-T
The link to download your SAF-T file.
SAF-T Link
202 GENERATING SAF-T
Your SAF-T file is being generated. You need to keep requesting until you get a response with HTTP status code 200.”
SAF-T Generating
422 INCORRECT PARAMETERS
Some parameters sent in the request were not valid.
(Empty Response)
500 FAILED TO GENERATE SAF-T
The SAF-T file generation failed.
SAF-T Generation failed

Example 200 Response Body

{
  "url": "https://some.url"
}

Example 202 Response Body

{
  "message": "The SAF-T file generation was started. Please keep requesting until you get back the url."
}

Example 500 Response Body

{
  "message": "Error generating SAF-T. Please try again."
}
Livro de Reclamação