GET
/
api
/
payments-received
{
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 10
  },
  "data": [
    {
      "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.

Response

200 - application/json

The payment received has been retrieved successfully.

The response is of type object.