Get the expense transaction details.

curl --request GET \
  --url https://api.example.com/api/expenses/{id} \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'

import requests

url = "https://api.example.com/api/expenses/{id}"

headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};

fetch('https://api.example.com/api/expenses/{id}', 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://api.example.com/api/expenses/{id}",
  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: <authorization>",
    "organization-id: <organization-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://api.example.com/api/expenses/{id}"

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/expenses/{id}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/expenses/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'

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

{
  "id": 1,
  "totalAmount": 1000,
  "currencyCode": "USD",
  "exchangeRate": 1.2,
  "paymentAccountId": 1,
  "referenceNo": "EXP-2024-001",
  "userId": 1,
  "paymentDate": "2024-03-20T10:00:00Z",
  "payeeId": 1,
  "landedCostAmount": 800,
  "allocatedCostAmount": 200,
  "invoicedAmount": 0,
  "branchId": 1,
  "createdAt": "2024-03-20T10:00:00Z",
  "isPublished": true,
  "unallocatedCostAmount": 200,
  "localAmount": 1200,
  "localLandedCostAmount": 960,
  "localAllocatedCostAmount": 240,
  "localUnallocatedCostAmount": 240,
  "billableAmount": 1000,
  "categories": [
    {
      "id": 1,
      "amount": 100,
      "allocatedCostAmount": 50,
      "expenseAccountId": 1,
      "description": "Office supplies for Q1",
      "unallocatedCostAmount": 50,
      "projectId": 1
    }
  ],
  "description": "Office supplies and equipment",
  "publishedAt": "2024-03-20T10:00:00Z"
}

GET

api

expenses

{id}

Get the expense transaction details.

curl --request GET \
  --url https://api.example.com/api/expenses/{id} \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'

import requests

url = "https://api.example.com/api/expenses/{id}"

headers = {
    "Authorization": "<authorization>",
    "organization-id": "<organization-id>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'organization-id': '<organization-id>'}
};

fetch('https://api.example.com/api/expenses/{id}', 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://api.example.com/api/expenses/{id}",
  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: <authorization>",
    "organization-id: <organization-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://api.example.com/api/expenses/{id}"

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("organization-id", "<organization-id>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/expenses/{id}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/expenses/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'

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

{
  "id": 1,
  "totalAmount": 1000,
  "currencyCode": "USD",
  "exchangeRate": 1.2,
  "paymentAccountId": 1,
  "referenceNo": "EXP-2024-001",
  "userId": 1,
  "paymentDate": "2024-03-20T10:00:00Z",
  "payeeId": 1,
  "landedCostAmount": 800,
  "allocatedCostAmount": 200,
  "invoicedAmount": 0,
  "branchId": 1,
  "createdAt": "2024-03-20T10:00:00Z",
  "isPublished": true,
  "unallocatedCostAmount": 200,
  "localAmount": 1200,
  "localLandedCostAmount": 960,
  "localAllocatedCostAmount": 240,
  "localUnallocatedCostAmount": 240,
  "billableAmount": 1000,
  "categories": [
    {
      "id": 1,
      "amount": 100,
      "allocatedCostAmount": 50,
      "expenseAccountId": 1,
      "description": "Office supplies for Q1",
      "unallocatedCostAmount": 50,
      "projectId": 1
    }
  ],
  "description": "Office supplies and equipment",
  "publishedAt": "2024-03-20T10:00:00Z"
}

Headers

Authorization

string

required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

organization-id

string

required

Required if Authorization is a JWT token. The organization ID to operate within.

Path Parameters

number

required

Response

200 - application/json

The expense transaction have been successfully retrieved.

number

required

The unique identifier of the expense

Example:

1

totalAmount

number

required

The total amount of the expense

Example:

1000

currencyCode

string

required

The currency code of the expense

Example:

"USD"

exchangeRate

number

required

The exchange rate used for the expense

Example:

1.2

paymentAccountId

number

required

The ID of the payment account used for this expense

Example:

1

referenceNo

string

required

The reference number of the expense

Example:

"EXP-2024-001"

userId

number

required

The ID of the user who created the expense

Example:

1

paymentDate

string<date-time>

required

The payment date of the expense

Example:

"2024-03-20T10:00:00Z"

payeeId

number

required

The ID of the payee

Example:

1

landedCostAmount

number

required

The landed cost amount of the expense

Example:

800

allocatedCostAmount

number

required

The allocated cost amount of the expense

Example:

200

invoicedAmount

number

required

The invoiced amount of the expense

Example:

0

branchId

number

required

The ID of the branch associated with the expense

Example:

1

createdAt

string<date-time>

required

The creation date of the expense

Example:

"2024-03-20T10:00:00Z"

isPublished

boolean

required

Whether the expense is published

Example:

true

unallocatedCostAmount

number

required

The unallocated cost amount of the expense

Example:

200

localAmount

number

required

The local amount of the expense (total amount * exchange rate)

Example:

1200

localLandedCostAmount

number

required

The local landed cost amount of the expense

Example:

960

localAllocatedCostAmount

number

required

The local allocated cost amount of the expense

Example:

240

localUnallocatedCostAmount

number

required

The local unallocated cost amount of the expense

Example:

240

billableAmount

number

required

The billable amount of the expense

Example:

1000

Get Started

API Reference

Get the expense transaction details.

Headers

Path Parameters

Response