Retrieves the bill payment details.

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

import requests

url = "https://api.example.com/api/bill-payments/{billPaymentId}"

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/bill-payments/{billPaymentId}', 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/bill-payments/{billPaymentId}",
  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/bill-payments/{billPaymentId}"

	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/bill-payments/{billPaymentId}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/bill-payments/{billPaymentId}")

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,
  "vendorId": 1,
  "amount": 100,
  "paymentAccountId": 2,
  "paymentDate": "2024-01-01",
  "formattedPaymentDate": "2024-01-01",
  "formattedAmount": "100.00 USD",
  "formattedTotal": "100.00 USD",
  "formattedSubtotal": "100.00 USD",
  "createdAt": "2024-01-01T12:00:00Z",
  "formattedCreatedAt": "2024-01-01",
  "entries": [
    {
      "paymentAmountFormatted": "100.00",
      "bill": {
        "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"
      }
    }
  ],
  "currencyCode": "USD",
  "paymentNumber": "PAY-2024-001",
  "exchangeRate": 1,
  "statement": "Payment for January bills",
  "reference": "REF-123",
  "branchId": 1,
  "updatedAt": "2024-01-02T12:00:00Z",
  "attachments": [
    {}
  ]
}

GET

api

bill-payments

{billPaymentId}

Retrieves the bill payment details.

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

import requests

url = "https://api.example.com/api/bill-payments/{billPaymentId}"

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/bill-payments/{billPaymentId}', 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/bill-payments/{billPaymentId}",
  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/bill-payments/{billPaymentId}"

	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/bill-payments/{billPaymentId}")
  .header("Authorization", "<authorization>")
  .header("organization-id", "<organization-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/bill-payments/{billPaymentId}")

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,
  "vendorId": 1,
  "amount": 100,
  "paymentAccountId": 2,
  "paymentDate": "2024-01-01",
  "formattedPaymentDate": "2024-01-01",
  "formattedAmount": "100.00 USD",
  "formattedTotal": "100.00 USD",
  "formattedSubtotal": "100.00 USD",
  "createdAt": "2024-01-01T12:00:00Z",
  "formattedCreatedAt": "2024-01-01",
  "entries": [
    {
      "paymentAmountFormatted": "100.00",
      "bill": {
        "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"
      }
    }
  ],
  "currencyCode": "USD",
  "paymentNumber": "PAY-2024-001",
  "exchangeRate": 1,
  "statement": "Payment for January bills",
  "reference": "REF-123",
  "branchId": 1,
  "updatedAt": "2024-01-02T12:00:00Z",
  "attachments": [
    {}
  ]
}

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

billPaymentId

number

required

The bill payment id

Response

200 - application/json

The bill payment details have been successfully retrieved.

number

required

The unique identifier of the bill payment

Example:

1

vendorId

number

required

The vendor ID

Example:

1

amount

number

required

The amount paid

Example:

100

paymentAccountId

number

required

The payment account ID

Example:

2

paymentDate

string

required

The payment date

Example:

"2024-01-01"

formattedPaymentDate

string

required

The formatted payment date

Example:

"2024-01-01"

formattedAmount

string

required

The formatted amount

Example:

"100.00 USD"

formattedTotal

string

required

The formatted total

Example:

"100.00 USD"

formattedSubtotal

string

required

The formatted subtotal

Example:

"100.00 USD"

createdAt

string<date-time>

required

The date when the payment was created

Example:

"2024-01-01T12:00:00Z"

formattedCreatedAt

string

required

The formatted created at date

Example:

"2024-01-01"

entries

object[]

required

The entries of the bill payment

Show child attributes

currencyCode

string

The currency code

Example:

"USD"

paymentNumber

string

The payment number

Example:

"PAY-2024-001"

exchangeRate

number

The exchange rate

Example:

1

statement

string

Statement or note

Example:

"Payment for January bills"

reference

string

Reference number

Example:

"REF-123"

branchId

number

The branch ID

Example:

1

updatedAt

string<date-time>

The date when the payment was last updated

Example:

"2024-01-02T12:00:00Z"

attachments

object[]

The attachments of the bill payment

Create a new bill payment.Edit the given bill payment.

Get Started

API Reference

Retrieves the bill payment details.

Headers

Path Parameters

Response