> ## Documentation Index > Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt > Use this file to discover all available pages before exploring further. # Retrieves the payment received details. ## OpenAPI ````yaml api-reference/openapi.json get /api/payments-received/{id} openapi: 3.0.0 info: title: Bigcapital description: Financial accounting software version: '1.0' contact: {} servers: [] security: [] tags: [] paths: /api/payments-received/{id}: get: tags: - Payments Received summary: Retrieves the payment received details. operationId: PaymentReceivesController_getPaymentReceive parameters: - name: Authorization in: header description: >- Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token. required: true schema: type: string example: Bearer bc_1234567890abcdef - name: organization-id in: header description: >- Required if Authorization is a JWT token. The organization ID to operate within. required: true schema: type: string - name: id required: true in: path schema: type: number - name: accept required: true in: header schema: type: string responses: '200': description: The payment received details have been successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/PaymentReceivedResponseDto' components: schemas: PaymentReceivedResponseDto: type: object properties: id: type: number description: The unique identifier of the payment received example: 1 paymentReceiveNo: type: string description: The payment receive number example: PR-001 paymentDate: type: object description: The date of the payment example: '2023-01-01T00:00:00Z' formattedPaymentDate: type: string description: The formatted payment date example: '2023-01-01' customerId: type: number description: The customer ID example: 1 referenceNo: type: string description: The reference number example: REF-001 amount: type: number description: The amount received example: 100 formattedAmount: type: string description: The formatted amount example: '100.00' formattedTotal: type: string description: The formatted total example: 100.00 USD currencyCode: type: string description: The currency code example: USD exchangeRate: type: number description: The exchange rate example: 1 formattedExchangeRate: type: string description: The formatted exchange rate example: '1.00' statement: type: string description: The statement or note example: Payment for invoice INV-001 depositAccountId: type: number description: The ID of the deposit account example: 2 depositAccount: description: Deposit account details allOf: - $ref: '#/components/schemas/AccountResponseDto' branchId: type: number description: The ID of the branch example: 1 branch: description: Branch details allOf: - $ref: '#/components/schemas/BranchResponseDto' pdfTemplateId: type: number description: The ID of the PDF template example: 1 pdfTemplate: type: object description: PDF template details example: id: 1 templateName: Default resource: PaymentReceive attributes: primaryColor: '#000000' userId: type: number description: The user ID who created the payment example: 5 createdAt: type: object description: The date when the payment was created example: '2023-01-01T00:00:00Z' formattedCreatedAt: type: string description: The formatted created at date example: '2023-01-01' updatedAt: type: object description: The date when the payment was last updated example: '2023-01-02T00:00:00Z' entries: description: 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 type: array items: $ref: '#/components/schemas/PaymentReceivedEntryResponseDto' attachments: description: The attachments of the payment received example: - key: file-uuid-1 - key: file-uuid-2 type: array items: $ref: '#/components/schemas/AttachmentLinkDto' required: - id - paymentReceiveNo - paymentDate - formattedPaymentDate - customerId - amount - formattedAmount - formattedTotal - currencyCode - exchangeRate - formattedExchangeRate - depositAccountId - depositAccount - userId - createdAt - formattedCreatedAt - entries AccountResponseDto: type: object properties: id: type: number description: The unique identifier of the account example: 1 name: type: string description: The name of the account example: Cash Account slug: type: string description: The slug of the account example: cash-account code: type: string description: The code of the account example: '1001' index: type: number description: The index of the account example: 1 accountType: type: string description: The type of the account example: bank accountTypeLabel: type: string description: The formatted account type label example: Bank Account parentAccountId: type: number description: The parent account ID example: null predefined: type: boolean description: Whether the account is predefined example: false currencyCode: type: string description: The currency code of the account example: USD active: type: boolean description: Whether the account is active example: true bankBalance: type: number description: The bank balance of the account example: 5000 bankBalanceFormatted: type: string description: The formatted bank balance example: $5,000.00 lastFeedsUpdatedAt: type: object description: The last feeds update timestamp example: '2024-03-20T10:30:00Z' lastFeedsUpdatedAtFormatted: type: string description: The formatted last feeds update timestamp example: Mar 20, 2024 10:30 AM amount: type: number description: The amount of the account example: 5000 formattedAmount: type: string description: The formatted amount example: $5,000.00 plaidItemId: type: string description: The Plaid item ID example: plaid-item-123 plaidAccountId: type: string description: The Plaid account ID example: plaid-account-456 isFeedsActive: type: boolean description: Whether the feeds are active example: true isSyncingOwner: type: boolean description: Whether the account is syncing owner example: true isFeedsPaused: type: boolean description: Whether the feeds are paused example: false accountNormal: type: string description: The account normal example: debit accountNormalFormatted: type: string description: The formatted account normal example: Debit flattenName: type: string description: The flatten name with all dependant accounts names example: 'Assets: Cash Account' accountLevel: type: number description: The account level in the hierarchy example: 2 createdAt: format: date-time type: string description: The creation timestamp example: '2024-03-20T10:00:00Z' updatedAt: format: date-time type: string description: The update timestamp example: '2024-03-20T10:30:00Z' required: - id - name - slug - code - index - accountType - accountTypeLabel - parentAccountId - predefined - currencyCode - active - bankBalance - bankBalanceFormatted - lastFeedsUpdatedAt - lastFeedsUpdatedAtFormatted - amount - formattedAmount - plaidItemId - plaidAccountId - isFeedsActive - isSyncingOwner - isFeedsPaused - accountNormal - accountNormalFormatted - flattenName - accountLevel - createdAt - updatedAt BranchResponseDto: type: object properties: id: type: number description: Branch ID example: 1 name: type: string description: Branch name example: Main Branch code: type: string description: Branch code example: BR001 address: type: string description: Branch address example: 123 Main Street city: type: string description: Branch city example: New York country: type: string description: Branch country example: USA phoneNumber: type: string description: Branch phone number example: +1-555-123-4567 email: type: string description: Branch email example: branch@example.com website: type: string description: Branch website example: https://www.example.com/branch primary: type: boolean description: Whether this is the primary branch example: true createdAt: format: date-time type: string description: Creation timestamp example: '2024-03-20T10:00:00Z' updatedAt: format: date-time type: string description: Last update timestamp example: '2024-03-20T10:00:00Z' required: - id - name - code - address - city - country - phoneNumber - email - website - primary - createdAt - updatedAt PaymentReceivedEntryResponseDto: type: object properties: id: type: number description: ID of the entry example: 1 index: type: number description: Index of the entry example: 0 paymentReceiveId: type: number description: ID of the payment received example: 1 invoiceId: type: number description: ID of the invoice example: 10 paymentAmount: type: number description: Amount paid for this invoice example: 100 paymentAmountFormatted: type: string description: Formatted paid amount example: '100.00' invoice: type: object description: Invoice details example: id: 10 invoiceNo: INV-001 total: 1000 dueAmount: 500 customerId: 1 required: - id - index - paymentReceiveId - invoiceId - paymentAmount - paymentAmountFormatted - invoice AttachmentLinkDto: type: object properties: {} ````