GET
/
api
/
payments-received
/
{id}
{
  "id": 1,
  "paymentReceiveNo": "PR-001",
  "paymentDate": "2023-01-01T00:00:00Z",
  "formattedPaymentDate": "2023-01-01",
  "customerId": 1,
  "referenceNo": "REF-001",
  "amount": 100,
  "formattedAmount": "100.00",
  "currencyCode": "USD",
  "exchangeRate": 1,
  "formattedExchangeRate": "1.00",
  "statement": "Payment for invoice INV-001",
  "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"
  },
  "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"
    }
  },
  "userId": 5,
  "createdAt": "2023-01-01T00:00:00Z",
  "formattedCreatedAt": "2023-01-01",
  "updatedAt": "2023-01-02T00:00:00Z",
  "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
      }
    }
  ],
  "attachments": [
    {
      "key": "file-uuid-1"
    },
    {
      "key": "file-uuid-2"
    }
  ]
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> 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.

​
accept
string
required

Path Parameters

​
id
number
required

Response

200 - application/json

The payment received details have been successfully retrieved.

​
id
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"

​
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

​
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

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

​
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" }
]