Retrieves customer payments by document number

Request

This API fetches customer payments that match the provided document number.

Path

documentNumberstringrequired
The document number to search.

Example: CS-00001
Default:

Query

limitinteger (int32)
Maximum number of results to return (default: 100).

Example: 1
Default: 100
offsetinteger (int32)
Offset for pagination (default: 0).

Example: 0
Default: 0

Responses

Returns the details of the business object

Body application/json

get /api/customer-payments/docno/{documentNumber}

curl -X GET \
  https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001

const url = 'https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const fetch = require('node-fetch');

const url = 'https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001"

response = requests.get(url)

print(response.json())

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001")
  .get()
  .build();

Response response = client.newCall(request).execute();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001"),
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/customer-payments/docno/CS-00001"

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

application/json

[
  {
    "DOCKEY": 1,
    "DOCNO": "CS-00001",
    "CODE": "300-C0002",
    "DOCDATE": "2024-06-15T00:00:00",
    "POSTDATE": "2024-06-15T00:00:00",
    "TAXDATE": "2024-06-15T00:00:00",
    "DESCRIPTION": "Payment For Account",
    "AREA": "----",
    "AGENT": "----",
    "PAYMENTMETHOD": "320-000",
    "CHEQUENUMBER": "",
    "JOURNAL": "CASH",
    "PROJECT": "----",
    "PAYMENTPROJECT": "----",
    "CURRENCYCODE": "----",
    "CURRENCYRATE": 1,
    "BANKACC": "",
    "BANKCHARGE": 0,
    "BANKCHARGEACCOUNT": "",
    "DOCAMT": 240,
    "LOCALDOCAMT": 240,
    "UNAPPLIEDAMT": 0,
    "DOCREF1": "",
    "DOCREF2": "",
    "FROMDOCTYPE": "CS",
    "FROMDOCKEY": "",
    "GLTRANSID": 19,
    "CANCELLED": "F",
    "NONREFUNDABLE": 0,
    "BOUNCEDDATE": "",
    "UPDATECOUNT": 1,
    "ATTACHMENTS": "",
    "NOTE": "",
    "LASTMODIFIED": 1730460194,
    "BANKTRANSFERTYPE": 0,
    "BANKREFNO": "",
    "BANKSTATUS": "",
    "BANKSTATUSDESC": "",
    "cdsKnockOff": [
      {
        "DOCKEY_1": 1,
        "FROMDOCTYPE_1": "PM",
        "FROMDOCKEY_1": 1,
        "TODOCTYPE": "IV",
        "TODOCKEY": 66,
        "KOAMT": 240,
        "ACTUALLOCALKOAMT": 240,
        "LOCALKOAMT": 240,
        "KOTAXDATE": "2024-06-15T00:00:00",
        "GAINLOSS": 0,
        "GAINLOSSPOSTDATE": ""
      },
      {
        "DOCKEY_1": 12,
        "FROMDOCTYPE_1": "CF",
        "FROMDOCKEY_1": 1,
        "TODOCTYPE": "CN",
        "TODOCKEY": 1,
        "KOAMT": 40,
        "ACTUALLOCALKOAMT": 40,
        "LOCALKOAMT": 40,
        "KOTAXDATE": "",
        "GAINLOSS": 0,
        "GAINLOSSPOSTDATE": ""
      }
    ]
  }
]

Retrieves customer payments by document number

Request

Path

Query

Responses200400

Body application/json

Body application/json

Responses