Skip to main content
POST
/
api
/
bill-payments
Create a new bill payment.
curl --request POST \
  --url https://api.example.com/api/bill-payments \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "vendorId": 1,
  "amount": 100,
  "paymentAccountId": 1,
  "paymentNumber": "123456",
  "paymentDate": "2021-01-01",
  "exchangeRate": 1,
  "statement": "123456",
  "entries": [
    {
      "billId": 1,
      "paymentAmount": 100
    }
  ],
  "branchId": 1,
  "attachments": [
    {
      "id": 1,
      "type": "bill"
    }
  ]
}
'
import requests

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

payload = {
"vendorId": 1,
"amount": 100,
"paymentAccountId": 1,
"paymentNumber": "123456",
"paymentDate": "2021-01-01",
"exchangeRate": 1,
"statement": "123456",
"entries": [
{
"billId": 1,
"paymentAmount": 100
}
],
"branchId": 1,
"attachments": [
{
"id": 1,
"type": "bill"
}
]
}
headers = {
"Authorization": "<authorization>",
"organization-id": "<organization-id>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
Authorization: '<authorization>',
'organization-id': '<organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
vendorId: 1,
amount: 100,
paymentAccountId: 1,
paymentNumber: '123456',
paymentDate: '2021-01-01',
exchangeRate: 1,
statement: '123456',
entries: [{billId: 1, paymentAmount: 100}],
branchId: 1,
attachments: [{id: 1, type: 'bill'}]
})
};

fetch('https://api.example.com/api/bill-payments', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vendorId' => 1,
'amount' => 100,
'paymentAccountId' => 1,
'paymentNumber' => '123456',
'paymentDate' => '2021-01-01',
'exchangeRate' => 1,
'statement' => '123456',
'entries' => [
[
'billId' => 1,
'paymentAmount' => 100
]
],
'branchId' => 1,
'attachments' => [
[
'id' => 1,
'type' => 'bill'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

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

payload := strings.NewReader("{\n \"vendorId\": 1,\n \"amount\": 100,\n \"paymentAccountId\": 1,\n \"paymentNumber\": \"123456\",\n \"paymentDate\": \"2021-01-01\",\n \"exchangeRate\": 1,\n \"statement\": \"123456\",\n \"entries\": [\n {\n \"billId\": 1,\n \"paymentAmount\": 100\n }\n ],\n \"branchId\": 1,\n \"attachments\": [\n {\n \"id\": 1,\n \"type\": \"bill\"\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<authorization>")
req.Header.Add("organization-id", "<organization-id>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/bill-payments")
.header("Authorization", "<authorization>")
.header("organization-id", "<organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"vendorId\": 1,\n \"amount\": 100,\n \"paymentAccountId\": 1,\n \"paymentNumber\": \"123456\",\n \"paymentDate\": \"2021-01-01\",\n \"exchangeRate\": 1,\n \"statement\": \"123456\",\n \"entries\": [\n {\n \"billId\": 1,\n \"paymentAmount\": 100\n }\n ],\n \"branchId\": 1,\n \"attachments\": [\n {\n \"id\": 1,\n \"type\": \"bill\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["organization-id"] = '<organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vendorId\": 1,\n \"amount\": 100,\n \"paymentAccountId\": 1,\n \"paymentNumber\": \"123456\",\n \"paymentDate\": \"2021-01-01\",\n \"exchangeRate\": 1,\n \"statement\": \"123456\",\n \"entries\": [\n {\n \"billId\": 1,\n \"paymentAmount\": 100\n }\n ],\n \"branchId\": 1,\n \"attachments\": [\n {\n \"id\": 1,\n \"type\": \"bill\"\n }\n ]\n}"

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

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.

Body

application/json
vendorId
number
required

The id of the vendor

Example:

1

amount
number
required

The amount of the bill payment

Example:

100

paymentAccountId
number
required

The id of the payment account

Example:

1

paymentNumber
string
required

The payment number of the bill payment

Example:

"123456"

paymentDate
object
required

The payment date of the bill payment

Example:

"2021-01-01"

exchangeRate
number
required

The exchange rate of the bill payment

Example:

1

statement
string
required

The statement of the bill payment

Example:

"123456"

entries
string[]
required

The entries of the bill payment

Example:
[{ "billId": 1, "paymentAmount": 100 }]
branchId
number
required

The id of the branch

Example:

1

attachments
string[]
required

The attachments of the bill payment

Example:
[{ "id": 1, "type": "bill" }]

Response

201 - undefined