> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Create Payment

- Component: `appmixer.zoho.books.CreatePayment`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.zoho.books 1.3.0](https://connectors.appmixer.com/connector/appmixer.zoho.books/1.3.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.zoho.books/1.3.0/component/appmixer.zoho.books.CreatePayment>

Record a customer payment in Zoho Books and apply it to one or more invoices.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Organization ID (`organizationId`) | text | Select the organization, or enter its ID. When empty, the default organization of the connected account is used. |
| Customer ID (`customerId`) | text | ID of the customer who made the payment. |
| Payment Mode (`paymentMode`) | select | How the payment was made. |
| Amount (`amount`) | number | Total amount of the payment. |
| Payment Date (`date`) | date-time | Date on which the payment was made. |
| Invoice ID (`invoiceId`) | text | ID of the invoice the payment is applied to. To split the payment over several invoices, use Invoices instead. |
| Amount Applied (`amountApplied`) | number | Amount applied to the invoice set in Invoice ID. Defaults to the payment Amount. |
| Invoices (`invoices`) | textarea | Invoices the payment is applied to, as a JSON array. Overrides Invoice ID and Amount Applied. Example: `[{"invoice_id": "460000000038080", "amount_applied": 300}, {"invoice_id": "460000000038095", "amount_applied": 150}]`. |
| Reference Number (`referenceNumber`) | text | Reference of the payment, e.g. the transaction ID in your payment provider. |
| Description (`description`) | textarea | Description of the payment. |
| Deposit Account ID (`accountId`) | text | ID of the cash or bank account the payment is deposited to. |
| Bank Charges (`bankCharges`) | number | Bank charges deducted from the payment. |
| Exchange Rate (`exchangeRate`) | number | Exchange rate between the payment currency and the base currency. Defaults to 1. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Payment ID (`payment_id`) | string | - |
| Payment Number (`payment_number`) | string | - |
| Payment Mode (`payment_mode`) | string | - |
| Amount (`amount`) | number | - |
| Bank Charges (`bank_charges`) | number | - |
| Date (`date`) | string | - |
| Reference Number (`reference_number`) | string | - |
| Description (`description`) | string | - |
| Customer ID (`customer_id`) | string | - |
| Customer Name (`customer_name`) | string | - |
| Email (`email`) | string | - |
| Currency Code (`currency_code`) | string | - |
| Invoices (`invoices`) | array | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.zoho.books.CreatePayment",
  "label": "Create Payment",
  "author": "Appmixer <info@appmixer.com>",
  "description": "Record a customer payment in Zoho Books and apply it to one or more invoices.",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:zoho:books",
    "scope": [
      "ZohoBooks.customerpayments.CREATE"
    ]
  },
  "quota": {
    "manager": "appmixer:zoho:books",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "organizationId": {
            "type": "string"
          },
          "customerId": {
            "type": "string"
          },
          "paymentMode": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "date": {
            "type": "string"
          },
          "invoiceId": {
            "type": "string"
          },
          "amountApplied": {
            "type": "number"
          },
          "invoices": {
            "type": "string"
          },
          "referenceNumber": {
            "type": "string",
            "maxLength": 100
          },
          "description": {
            "type": "string"
          },
          "accountId": {
            "type": "string"
          },
          "bankCharges": {
            "type": "number"
          },
          "exchangeRate": {
            "type": "number"
          }
        },
        "required": [
          "customerId",
          "paymentMode",
          "amount",
          "date"
        ]
      },
      "inspector": {
        "inputs": {
          "organizationId": {
            "type": "text",
            "label": "Organization ID",
            "index": 0,
            "tooltip": "Select the organization, or enter its ID. When empty, the default organization of the connected account is used.",
            "source": {
              "url": "/component/appmixer/zoho/books/ListOrganizations?outPort=out",
              "data": {
                "transform": "./transformers#organizationsToSelectArray"
              }
            }
          },
          "customerId": {
            "type": "text",
            "label": "Customer ID",
            "index": 1,
            "tooltip": "ID of the customer who made the payment."
          },
          "paymentMode": {
            "type": "select",
            "label": "Payment Mode",
            "index": 2,
            "tooltip": "How the payment was made.",
            "options": [
              {
                "label": "Cash",
                "value": "cash"
              },
              {
                "label": "Check",
                "value": "check"
              },
              {
                "label": "Credit Card",
                "value": "creditcard"
              },
              {
                "label": "Bank Transfer",
                "value": "banktransfer"
              },
              {
                "label": "Bank Remittance",
                "value": "bankremittance"
              },
              {
                "label": "Auto Transaction",
                "value": "autotransaction"
              },
              {
                "label": "Others",
                "value": "others"
              }
            ]
          },
          "amount": {
            "type": "number",
            "label": "Amount",
            "index": 3,
            "tooltip": "Total amount of the payment."
          },
          "date": {
            "type": "date-time",
            "label": "Payment Date",
            "index": 4,
            "tooltip": "Date on which the payment was made.",
            "config": {
              "format": "YYYY-MM-DD",
              "enableTime": false
            }
          },
          "invoiceId": {
            "type": "text",
            "label": "Invoice ID",
            "index": 5,
            "tooltip": "ID of the invoice the payment is applied to. To split the payment over several invoices, use Invoices instead."
          },
          "amountApplied": {
            "type": "number",
            "label": "Amount Applied",
            "index": 6,
            "tooltip": "Amount applied to the invoice set in Invoice ID. Defaults to the payment Amount."
          },
          "invoices": {
            "type": "textarea",
            "label": "Invoices",
            "index": 7,
            "tooltip": "Invoices the payment is applied to, as a JSON array. Overrides Invoice ID and Amount Applied. Example: <code>[{\"invoice_id\": \"460000000038080\", \"amount_applied\": 300}, {\"invoice_id\": \"460000000038095\", \"amount_applied\": 150}]</code>."
          },
          "referenceNumber": {
            "type": "text",
            "label": "Reference Number",
            "index": 8,
            "tooltip": "Reference of the payment, e.g. the transaction ID in your payment provider."
          },
          "description": {
            "type": "textarea",
            "label": "Description",
            "index": 9,
            "tooltip": "Description of the payment."
          },
          "accountId": {
            "type": "text",
            "label": "Deposit Account ID",
            "index": 10,
            "tooltip": "ID of the cash or bank account the payment is deposited to."
          },
          "bankCharges": {
            "type": "number",
            "label": "Bank Charges",
            "index": 11,
            "tooltip": "Bank charges deducted from the payment."
          },
          "exchangeRate": {
            "type": "number",
            "label": "Exchange Rate",
            "index": 12,
            "tooltip": "Exchange rate between the payment currency and the base currency. Defaults to 1."
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "properties": {
          "payment_id": {
            "type": "string",
            "title": "Payment ID",
            "example": "460000000042061"
          },
          "payment_number": {
            "type": "string",
            "title": "Payment Number",
            "example": "2"
          },
          "payment_mode": {
            "type": "string",
            "title": "Payment Mode",
            "example": "cash"
          },
          "amount": {
            "type": "number",
            "title": "Amount",
            "example": 450
          },
          "bank_charges": {
            "type": "number",
            "title": "Bank Charges",
            "example": 0
          },
          "date": {
            "type": "string",
            "title": "Date",
            "example": "2026-11-13"
          },
          "reference_number": {
            "type": "string",
            "title": "Reference Number",
            "example": "INV-384"
          },
          "description": {
            "type": "string",
            "title": "Description",
            "example": "Payment has been added to INV-384"
          },
          "customer_id": {
            "type": "string",
            "title": "Customer ID",
            "example": "460000000026049"
          },
          "customer_name": {
            "type": "string",
            "title": "Customer Name",
            "example": "Bowman Furniture"
          },
          "email": {
            "type": "string",
            "title": "Email",
            "example": "benjamin.geri@bowmanfurniture.com"
          },
          "currency_code": {
            "type": "string",
            "title": "Currency Code",
            "example": "USD"
          },
          "invoices": {
            "type": "array",
            "title": "Invoices",
            "example": [
              {
                "invoice_id": "460000000038080",
                "invoice_number": "INV-00001",
                "date": "2026-11-01",
                "invoice_amount": 450,
                "amount_applied": 450,
                "balance_amount": 0
              }
            ],
            "items": {
              "type": "object",
              "properties": {
                "invoice_id": {
                  "type": "string",
                  "title": "Invoices.Invoice ID",
                  "example": "460000000038080"
                },
                "invoice_number": {
                  "type": "string",
                  "title": "Invoices.Invoice Number",
                  "example": "INV-00001"
                },
                "date": {
                  "type": "string",
                  "title": "Invoices.Date",
                  "example": "2026-11-01"
                },
                "invoice_amount": {
                  "type": "number",
                  "title": "Invoices.Invoice Amount",
                  "example": 450
                },
                "amount_applied": {
                  "type": "number",
                  "title": "Invoices.Amount Applied",
                  "example": 450
                },
                "balance_amount": {
                  "type": "number",
                  "title": "Invoices.Balance Amount",
                  "example": 0
                }
              }
            }
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
