Retrieves the bill details.

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

import requests

url = "https://api.example.com/api/bills/{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/bills/{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/bills/{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/bills/{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/bills/{id}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/bills/{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,
  "billNumber": "BILL-2024-001",
  "billDate": "2024-03-15T00:00:00Z",
  "dueDate": "2024-04-15T00:00:00Z",
  "vendorId": 1001,
  "entries": [
    {
      "index": 1,
      "itemId": 1,
      "rate": 1,
      "quantity": 1,
      "discount": 1,
      "discountType": "percentage",
      "description": "This is a description",
      "taxCode": "123456",
      "taxRateId": 1,
      "warehouseId": 1,
      "projectId": 1,
      "projectRefId": 1,
      "projectRefType": "TASK",
      "projectRefInvoicedAmount": 100,
      "sellAccountId": 1020,
      "costAccountId": 1021
    }
  ],
  "balance": 1000,
  "paymentAmount": 500,
  "subtotal": 900,
  "total": 1000,
  "dueAmount": 500,
  "isOverdue": false,
  "isPartiallyPaid": true,
  "isFullyPaid": false,
  "createdAt": "2024-03-15T00:00:00Z",
  "referenceNo": "PO-2024-001",
  "exchangeRate": 1.25,
  "currencyCode": "USD",
  "note": "Office supplies and equipment for Q2 2024",
  "isInclusiveTax": false,
  "warehouseId": 101,
  "branchId": 201,
  "branch": {
    "id": 1,
    "name": "Main Branch",
    "code": "BR001",
    "address": "123 Main Street",
    "city": "New York",
    "country": "USA",
    "phoneNumber": "+1-555-123-4567",
    "email": "[email protected]",
    "website": "https://www.example.com/branch",
    "primary": true,
    "createdAt": "2024-03-20T10:00:00Z",
    "updatedAt": "2024-03-20T10:00:00Z"
  },
  "projectId": 301,
  "attachments": [
    {}
  ],
  "discount": 100,
  "discountType": "amount",
  "adjustment": 50,
  "taxAmountWithheld": 50,
  "creditedAmount": 0,
  "updatedAt": "2024-03-16T00:00:00Z"
}

GET

api

bills

{id}

Retrieves the bill details.

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

import requests

url = "https://api.example.com/api/bills/{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/bills/{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/bills/{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/bills/{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/bills/{id}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/bills/{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,
  "billNumber": "BILL-2024-001",
  "billDate": "2024-03-15T00:00:00Z",
  "dueDate": "2024-04-15T00:00:00Z",
  "vendorId": 1001,
  "entries": [
    {
      "index": 1,
      "itemId": 1,
      "rate": 1,
      "quantity": 1,
      "discount": 1,
      "discountType": "percentage",
      "description": "This is a description",
      "taxCode": "123456",
      "taxRateId": 1,
      "warehouseId": 1,
      "projectId": 1,
      "projectRefId": 1,
      "projectRefType": "TASK",
      "projectRefInvoicedAmount": 100,
      "sellAccountId": 1020,
      "costAccountId": 1021
    }
  ],
  "balance": 1000,
  "paymentAmount": 500,
  "subtotal": 900,
  "total": 1000,
  "dueAmount": 500,
  "isOverdue": false,
  "isPartiallyPaid": true,
  "isFullyPaid": false,
  "createdAt": "2024-03-15T00:00:00Z",
  "referenceNo": "PO-2024-001",
  "exchangeRate": 1.25,
  "currencyCode": "USD",
  "note": "Office supplies and equipment for Q2 2024",
  "isInclusiveTax": false,
  "warehouseId": 101,
  "branchId": 201,
  "branch": {
    "id": 1,
    "name": "Main Branch",
    "code": "BR001",
    "address": "123 Main Street",
    "city": "New York",
    "country": "USA",
    "phoneNumber": "+1-555-123-4567",
    "email": "[email protected]",
    "website": "https://www.example.com/branch",
    "primary": true,
    "createdAt": "2024-03-20T10:00:00Z",
    "updatedAt": "2024-03-20T10:00:00Z"
  },
  "projectId": 301,
  "attachments": [
    {}
  ],
  "discount": 100,
  "discountType": "amount",
  "adjustment": 50,
  "taxAmountWithheld": 50,
  "creditedAmount": 0,
  "updatedAt": "2024-03-16T00: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

The bill id

Response

200 - application/json

The bill details have been successfully retrieved.

number

required

The unique identifier of the bill

Example:

1

billNumber

string

required

The bill number

Example:

"BILL-2024-001"

billDate

string<date-time>

required

The date the bill was issued

Example:

"2024-03-15T00:00:00Z"

dueDate

string<date-time>

required

The due date of the bill

Example:

"2024-04-15T00:00:00Z"

vendorId

number

required

The ID of the vendor

Example:

1001

entries

object[]

required

The line items of the bill

Show child attributes

balance

number

required

The balance of the bill

Example:

1000

paymentAmount

number

required

The amount paid

Example:

500

subtotal

number

required

The subtotal amount before tax and adjustments

Example:

900

total

number

required

The total amount including tax and adjustments

Example:

1000

dueAmount

number

required

The due amount remaining to be paid

Example:

500

isOverdue

boolean

required

Whether the bill is overdue

Example:

false

isPartiallyPaid

boolean

required

Whether the bill is partially paid

Example:

true

isFullyPaid

boolean

required

Whether the bill is fully paid

Example:

false

createdAt

string<date-time>

required

The date when the bill was created

Example:

"2024-03-15T00:00:00Z"

referenceNo

string

The reference number

Example:

"PO-2024-001"

exchangeRate

number

The exchange rate for currency conversion

Example:

1.25

currencyCode

string

The currency code

Example:

"USD"

note

string

Additional notes about the bill

Example:

"Office supplies and equipment for Q2 2024"

isInclusiveTax

boolean

Whether tax is inclusive in the item rates

Example:

false

warehouseId

number

The ID of the warehouse

Example:

101

branchId

number

The ID of the branch

Example:

201

branch

object

Branch details

Show child attributes

projectId

number

The ID of the project

Example:

301

attachments

object[]

The attachments of the bill

discount

number

The discount value

Example:

100

discountType

enum<string>

The type of discount (percentage or fixed)

Available options:

percentage,

amount

Example:

"amount"

adjustment

number

The adjustment amount

Example:

50

taxAmountWithheld

number

The total amount of tax withheld

Example:

50

creditedAmount

number

The amount credited

Example:

0

updatedAt

string<date-time>

The date when the bill was last updated

Example:

"2024-03-16T00:00:00Z"

Create a new bill.Edit the given bill.

Get Started

API Reference

Retrieves the bill details.

Headers

Path Parameters

Response