API-v2

Application Programming Interface

InvoiceXpress Documentation



List All


GET /guides.json

Returns all your guides (shippings, transports and devolutions). You can filter your guides by passing parameters in the query string.

Example Request

curl

curl --request GET \
  --url 'https://account_name.app.invoicexpress.com/guides.json?text=foo&type%5B%5D=Shipping&status%5B%5D=sent&loaded_at%5Bfrom%5D=30%2F09%2F2017&loaded_at%5Bto%5D=31%2F10%2F2017&non_archived=true&archived=false&page=1&per_page=10&api_key=YOUR%20API%20KEY%20HERE' \
  --header 'accept: application/json'

Ruby

require 'uri'
require 'net/http'

url = URI("https://account_name.app.invoicexpress.com/guides.json?text=foo&type%5B%5D=Shipping&status%5B%5D=sent&loaded_at%5Bfrom%5D=30%2F09%2F2017&loaded_at%5Bto%5D=31%2F10%2F2017&non_archived=true&archived=false&page=1&per_page=10&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": "/guides.json?text=foo&type%5B%5D=Shipping&status%5B%5D=sent&loaded_at%5Bfrom%5D=30%2F09%2F2017&loaded_at%5Bto%5D=31%2F10%2F2017&non_archived=true&archived=false&page=1&per_page=10&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", "/guides.json?text=foo&type%5B%5D=Shipping&status%5B%5D=sent&loaded_at%5Bfrom%5D=30%2F09%2F2017&loaded_at%5Bto%5D=31%2F10%2F2017&non_archived=true&archived=false&page=1&per_page=10&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/guides.json?text=foo&type%5B%5D=Shipping&status%5B%5D=sent&loaded_at%5Bfrom%5D=30%2F09%2F2017&loaded_at%5Bto%5D=31%2F10%2F2017&non_archived=true&archived=false&page=1&per_page=10&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/guides.json?text=foo&type%5B%5D=Shipping&status%5B%5D=sent&loaded_at%5Bfrom%5D=30%2F09%2F2017&loaded_at%5Bto%5D=31%2F10%2F2017&non_archived=true&archived=false&page=1&per_page=10&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))

}

Query Parameters

Name Type Required Description Example
text String Search for guide, client or item details. foo
type[] String Required Possible values: Shipping, Transport or Devolution. Shipping
status[] String Required Possible values: draft, sent, canceled or second_copy. sent
loaded_at[from] String Date in format dd/mm/yyyy. Ex: 30/09/2017 30%2F09%2F2017
loaded_at[to] String Date in format dd/mm/yyyy. Ex: 31/10/2017 31%2F10%2F2017
non_archived Boolean Required Possible values: true or false. true
archived Boolean Possible values: true or false. false
page Integer You can ask for a specific page of guides. Defaults to 1. 1
per_page String You can specify how many results you want to fetch. Defaults to 10 or value defined in account settings (10, 20 or 30). 30

Responses

200 SUCCESS
Guides were returned successfully.
Guides List all
401 ACCESS DENIED
The API Key parameter is missing or is incorrectly entered.
(Empty Response)

Example Success Body Response

{
  "guides": [
    {
      "id": 541797,
      "status": "final",
      "archived": false,
      "type": "Shipping",
      "sequence_number": "1/D",
      "inverted_sequence_number": "D/1",
      "date": "13/07/2017",
      "due_date": "foo",
      "reference": "foo",
      "observations": "foo",
      "retention": "foo",
      "permalink": "https://www.app.invoicexpress.com/documents/541797d75bbee48911934cbd4a4294946a324295f52b08",
      "saft_hash": "vaDf",
      "sum": 1,
      "discount": 0,
      "before_taxes": 1,
      "taxes": 0.07,
      "total": 1.07,
      "currency": "Euro",
      "address_from": {
        "country": "Portugal",
        "postal_code": "1050-083",
        "detail": "Avenida Duque D'Avila, 46 - 3ºA",
        "city": "Lisboa"
      },
      "address_to": {
        "country": "Portugal",
        "postal_code": "4000-327",
        "detail": "Avenida dos Aliados",
        "city": "Porto"
      },
      "client": {
        "id": 1310176,
        "name": "John",
        "country": "Portugal"
      },
      "items": [
        {
          "name": "iPhone",
          "description": "foo",
          "unit_price": "1.0",
          "unit": "foo",
          "quantity": "1.0",
          "tax": {
            "id": 31597,
            "name": "IVA7",
            "value": 7
          },
          "discount": 0,
          "subtotal": 1,
          "tax_amount": 0.07,
          "discount_amount": 0,
          "total": 1.07
        }
      ],
      "sequence_id": "12345",
      "tax_exemption": "M01",
      "at_doc_code_id": "999",
      "license_plate": "11-AA-22"
    }
  ],
  "pagination": {
    "total_entries": 6,
    "current_page": 1,
    "total_pages": 1,
    "per_page": 10
  }
}
Livro de Reclamação