Get a paginated transactions list. - Documentação: Extat Plataforma

GET

/

companies

/

transactions

Get a paginated transactions list.

curl --request GET \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions \
  --header 'Authorization: <api-key>' \
  --header 'x-company-id: <x-company-id>'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

headers = {
    "x-company-id": "<x-company-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-company-id': '<x-company-id>', Authorization: '<api-key>'}
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-company-id: <x-company-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

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

	req.Header.Add("x-company-id", "<x-company-id>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'

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

{}

{}

{}

Authorizations

Authorization

string

header

required

Token da sessão no cabeçalho Authorization, no formato Bearer (mesmo esquema ApiKeyAuth do contrato).

Headers

x-company-id

string

required

company uuid

Query Parameters

page

integer

required

current page

limit

integer

required

max result per page

date_type

string

type of date filter (e.g., due_date, competence, payment_date)

start_date

string

start date for filtering (YYYY-MM-DD)

end_date

string

end date for filtering (YYYY-MM-DD)

cost_centers

string[]

list of cost center IDs for filtering

categories

string[]

list of category IDs for filtering

status

string[]

list of statuses for filtering

suppliers

string[]

list of supplier IDs for filtering

bank_accounts

string[]

list of bank account IDs for filtering

Response

OK

The response is of type object.

Get a paginated transactions list.

curl --request GET \
  --url https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions \
  --header 'Authorization: <api-key>' \
  --header 'x-company-id: <x-company-id>'

import requests

url = "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

headers = {
    "x-company-id": "<x-company-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-company-id': '<x-company-id>', Authorization: '<api-key>'}
};

fetch('https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-company-id: <x-company-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions"

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

	req.Header.Add("x-company-id", "<x-company-id>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")
  .header("x-company-id", "<x-company-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://golang-api-vgnqx.ondigitalocean.app/v1/companies/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-company-id"] = '<x-company-id>'
request["Authorization"] = '<api-key>'

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

{}

{}

{}