> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Payment POST https://billing/payments Content-Type: multipart/form-data Reference: https://docs.itspropel.com/propel-biz/17-billing/payments/create-payment ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /billing/payments: post: operationId: create-payment summary: Create Payment tags: - subpackage_17Billing.subpackage_17Billing/payments parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/17 Billing_Payments_Create Payment_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: notes: type: string description: >- Optional: Payment notes - max 2000 chars - "Payment for March services" amount: type: string description: 'Required: Payment amount - numeric min:0.01 - 250.00' customer_id: type: string description: >- Required: Customer ID - must exist in customers table - "{{customer_id}}" payment_date: type: string description: >- Required: Date payment was received - date format - "2026-03-05" payment_type: type: string description: 'Optional: Payment type - standard|deposit - "standard"' work_order_id: type: string description: >- Optional: Associated work order ID - must exist in work_orders - "{{work_order_id}}" payment_method: type: string description: >- Required: Payment method - cash|check|credit_card|ach|external - "check" reference_number: type: string description: >- Optional: Reference/check number - max 100 chars - "CHK-12345" allocations[0][amount]: type: string description: >- Required with allocations: Amount to allocate - numeric min:0.01 - 250.00 allocations[0][invoice_id]: type: string description: >- Required with allocations: Invoice to allocate to - must exist in invoices - "{{invoice_id}}" required: - notes - amount - customer_id - payment_date - payment_type - work_order_id - payment_method - reference_number - allocations[0][amount] - allocations[0][invoice_id] servers: - url: https:/ components: schemas: 17 Billing_Payments_Create Payment_Response_200: type: object properties: {} description: Empty response body title: 17 Billing_Payments_Create Payment_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/billing/payments" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPayment for March services\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\nCUST-987654\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_date\"\r\n\r\n2026-03-05\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\nWO-123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_method\"\r\n\r\ncheck\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reference_number\"\r\n\r\nCHK-12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][amount]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][invoice_id]\"\r\n\r\nINV-654321\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/billing/payments'; const form = new FormData(); form.append('notes', 'Payment for March services'); form.append('amount', '150.00'); form.append('customer_id', 'CUST-987654'); form.append('payment_date', '2026-03-05'); form.append('payment_type', 'standard'); form.append('work_order_id', 'WO-123456'); form.append('payment_method', 'check'); form.append('reference_number', 'CHK-12345'); form.append('allocations[0][amount]', '150.00'); form.append('allocations[0][invoice_id]', 'INV-654321'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/billing/payments" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPayment for March services\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\nCUST-987654\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_date\"\r\n\r\n2026-03-05\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\nWO-123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_method\"\r\n\r\ncheck\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reference_number\"\r\n\r\nCHK-12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][amount]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][invoice_id]\"\r\n\r\nINV-654321\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/billing/payments") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPayment for March services\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\nCUST-987654\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_date\"\r\n\r\n2026-03-05\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\nWO-123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_method\"\r\n\r\ncheck\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reference_number\"\r\n\r\nCHK-12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][amount]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][invoice_id]\"\r\n\r\nINV-654321\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/billing/payments") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPayment for March services\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\nCUST-987654\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_date\"\r\n\r\n2026-03-05\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\nWO-123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_method\"\r\n\r\ncheck\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reference_number\"\r\n\r\nCHK-12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][amount]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][invoice_id]\"\r\n\r\nINV-654321\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/billing/payments', [ 'multipart' => [ [ 'name' => 'notes', 'contents' => 'Payment for March services' ], [ 'name' => 'amount', 'contents' => '150.00' ], [ 'name' => 'customer_id', 'contents' => 'CUST-987654' ], [ 'name' => 'payment_date', 'contents' => '2026-03-05' ], [ 'name' => 'payment_type', 'contents' => 'standard' ], [ 'name' => 'work_order_id', 'contents' => 'WO-123456' ], [ 'name' => 'payment_method', 'contents' => 'check' ], [ 'name' => 'reference_number', 'contents' => 'CHK-12345' ], [ 'name' => 'allocations[0][amount]', 'contents' => '150.00' ], [ 'name' => 'allocations[0][invoice_id]', 'contents' => 'INV-654321' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/billing/payments"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"notes\"\r\n\r\nPayment for March services\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"amount\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\nCUST-987654\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_date\"\r\n\r\n2026-03-05\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_type\"\r\n\r\nstandard\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\nWO-123456\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payment_method\"\r\n\r\ncheck\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reference_number\"\r\n\r\nCHK-12345\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][amount]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allocations[0][invoice_id]\"\r\n\r\nINV-654321\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "notes", "value": "Payment for March services" ], [ "name": "amount", "value": "150.00" ], [ "name": "customer_id", "value": "CUST-987654" ], [ "name": "payment_date", "value": "2026-03-05" ], [ "name": "payment_type", "value": "standard" ], [ "name": "work_order_id", "value": "WO-123456" ], [ "name": "payment_method", "value": "check" ], [ "name": "reference_number", "value": "CHK-12345" ], [ "name": "allocations[0][amount]", "value": "150.00" ], [ "name": "allocations[0][invoice_id]", "value": "INV-654321" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/billing/payments")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```