Retrieves the payment received details.

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

import requests

url = "https://api.example.com/api/payments-received/{id}"

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

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

print(response.text)

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

fetch('https://api.example.com/api/payments-received/{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/payments-received/{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>",
    "accept: <accept>",
    "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/payments-received/{id}"

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

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

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

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/payments-received/{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>'
request["accept"] = '<accept>'

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

{
  "id": 1,
  "paymentReceiveNo": "PR-001",
  "paymentDate": "2023-01-01T00:00:00Z",
  "formattedPaymentDate": "2023-01-01",
  "customerId": 1,
  "amount": 100,
  "formattedAmount": "100.00",
  "formattedTotal": "100.00 USD",
  "currencyCode": "USD",
  "exchangeRate": 1,
  "formattedExchangeRate": "1.00",
  "depositAccountId": 2,
  "depositAccount": {
    "id": 1,
    "name": "Cash Account",
    "slug": "cash-account",
    "code": "1001",
    "index": 1,
    "accountType": "bank",
    "accountTypeLabel": "Bank Account",
    "parentAccountId": null,
    "predefined": false,
    "currencyCode": "USD",
    "active": true,
    "bankBalance": 5000,
    "bankBalanceFormatted": "$5,000.00",
    "lastFeedsUpdatedAt": "2024-03-20T10:30:00Z",
    "lastFeedsUpdatedAtFormatted": "Mar 20, 2024 10:30 AM",
    "amount": 5000,
    "formattedAmount": "$5,000.00",
    "plaidItemId": "plaid-item-123",
    "plaidAccountId": "plaid-account-456",
    "isFeedsActive": true,
    "isSyncingOwner": true,
    "isFeedsPaused": false,
    "accountNormal": "debit",
    "accountNormalFormatted": "Debit",
    "flattenName": "Assets: Cash Account",
    "accountLevel": 2,
    "createdAt": "2024-03-20T10:00:00Z",
    "updatedAt": "2024-03-20T10:30:00Z"
  },
  "userId": 5,
  "createdAt": "2023-01-01T00:00:00Z",
  "formattedCreatedAt": "2023-01-01",
  "entries": [
    {
      "id": 1,
      "index": 0,
      "paymentReceiveId": 1,
      "invoiceId": 10,
      "paymentAmount": 100,
      "paymentAmountFormatted": "100.00",
      "invoice": {
        "id": 10,
        "invoiceNo": "INV-001",
        "total": 1000,
        "dueAmount": 500,
        "customerId": 1
      }
    }
  ],
  "referenceNo": "REF-001",
  "statement": "Payment for invoice INV-001",
  "branchId": 1,
  "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"
  },
  "pdfTemplateId": 1,
  "pdfTemplate": {
    "id": 1,
    "templateName": "Default",
    "resource": "PaymentReceive",
    "attributes": {
      "primaryColor": "#000000"
    }
  },
  "updatedAt": "2023-01-02T00:00:00Z",
  "attachments": [
    {
      "key": "file-uuid-1"
    },
    {
      "key": "file-uuid-2"
    }
  ]
}

GET

api

payments-received

{id}

Retrieves the payment received details.

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

import requests

url = "https://api.example.com/api/payments-received/{id}"

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

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

print(response.text)

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

fetch('https://api.example.com/api/payments-received/{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/payments-received/{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>",
    "accept: <accept>",
    "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/payments-received/{id}"

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

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

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

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/payments-received/{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>'
request["accept"] = '<accept>'

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

{
  "id": 1,
  "paymentReceiveNo": "PR-001",
  "paymentDate": "2023-01-01T00:00:00Z",
  "formattedPaymentDate": "2023-01-01",
  "customerId": 1,
  "amount": 100,
  "formattedAmount": "100.00",
  "formattedTotal": "100.00 USD",
  "currencyCode": "USD",
  "exchangeRate": 1,
  "formattedExchangeRate": "1.00",
  "depositAccountId": 2,
  "depositAccount": {
    "id": 1,
    "name": "Cash Account",
    "slug": "cash-account",
    "code": "1001",
    "index": 1,
    "accountType": "bank",
    "accountTypeLabel": "Bank Account",
    "parentAccountId": null,
    "predefined": false,
    "currencyCode": "USD",
    "active": true,
    "bankBalance": 5000,
    "bankBalanceFormatted": "$5,000.00",
    "lastFeedsUpdatedAt": "2024-03-20T10:30:00Z",
    "lastFeedsUpdatedAtFormatted": "Mar 20, 2024 10:30 AM",
    "amount": 5000,
    "formattedAmount": "$5,000.00",
    "plaidItemId": "plaid-item-123",
    "plaidAccountId": "plaid-account-456",
    "isFeedsActive": true,
    "isSyncingOwner": true,
    "isFeedsPaused": false,
    "accountNormal": "debit",
    "accountNormalFormatted": "Debit",
    "flattenName": "Assets: Cash Account",
    "accountLevel": 2,
    "createdAt": "2024-03-20T10:00:00Z",
    "updatedAt": "2024-03-20T10:30:00Z"
  },
  "userId": 5,
  "createdAt": "2023-01-01T00:00:00Z",
  "formattedCreatedAt": "2023-01-01",
  "entries": [
    {
      "id": 1,
      "index": 0,
      "paymentReceiveId": 1,
      "invoiceId": 10,
      "paymentAmount": 100,
      "paymentAmountFormatted": "100.00",
      "invoice": {
        "id": 10,
        "invoiceNo": "INV-001",
        "total": 1000,
        "dueAmount": 500,
        "customerId": 1
      }
    }
  ],
  "referenceNo": "REF-001",
  "statement": "Payment for invoice INV-001",
  "branchId": 1,
  "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"
  },
  "pdfTemplateId": 1,
  "pdfTemplate": {
    "id": 1,
    "templateName": "Default",
    "resource": "PaymentReceive",
    "attributes": {
      "primaryColor": "#000000"
    }
  },
  "updatedAt": "2023-01-02T00:00:00Z",
  "attachments": [
    {
      "key": "file-uuid-1"
    },
    {
      "key": "file-uuid-2"
    }
  ]
}

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.

string

required

Path Parameters

number

required

Response

200 - application/json

The payment received details have been successfully retrieved.

number

required

The unique identifier of the payment received

Example:

1

paymentReceiveNo

string

required

The payment receive number

Example:

"PR-001"

paymentDate

object

required

The date of the payment

Example:

"2023-01-01T00:00:00Z"

formattedPaymentDate

string

required

The formatted payment date

Example:

"2023-01-01"

customerId

number

required

The customer ID

Example:

1

amount

number

required

The amount received

Example:

100

formattedAmount

string

required

The formatted amount

Example:

"100.00"

formattedTotal

string

required

The formatted total

Example:

"100.00 USD"

currencyCode

string

required

The currency code

Example:

"USD"

exchangeRate

number

required

The exchange rate

Example:

1

formattedExchangeRate

string

required

The formatted exchange rate

Example:

"1.00"

depositAccountId

number

required

The ID of the deposit account

Example:

2

depositAccount

object

required

Deposit account details

Show child attributes

userId

number

required

The user ID who created the payment

Example:

5

createdAt

object

required

The date when the payment was created

Example:

"2023-01-01T00:00:00Z"

formattedCreatedAt

string

required

The formatted created at date

Example:

"2023-01-01"

entries

object[]

required

The entries of the payment received

Show child attributes

Example:

[
  {
    "id": 1,
    "index": 0,
    "paymentReceiveId": 1,
    "invoiceId": 10,
    "paymentAmount": 100,
    "paymentAmountFormatted": "100.00",
    "invoice": {
      "id": 10,
      "invoiceNo": "INV-001",
      "total": 1000,
      "dueAmount": 500,
      "customerId": 1
    }
  }
]

referenceNo

string

The reference number

Example:

"REF-001"

statement

string

The statement or note

Example:

"Payment for invoice INV-001"

branchId

number

The ID of the branch

Example:

1

branch

object

Branch details

Show child attributes

pdfTemplateId

number

The ID of the PDF template

Example:

1

pdfTemplate

object

PDF template details

Example:

{
  "id": 1,
  "templateName": "Default",
  "resource": "PaymentReceive",
  "attributes": { "primaryColor": "#000000" }
}

updatedAt

object

The date when the payment was last updated

Example:

"2023-01-02T00:00:00Z"

attachments

object[]

The attachments of the payment received

Example:

[
  { "key": "file-uuid-1" },
  { "key": "file-uuid-2" }
]

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

Get Started

API Reference

Retrieves the payment received details.

Headers

Path Parameters

Response