Mark invoice as paid

Records a manual payment against the invoice. Status changes to 'paid'. Use when payment was collected outside of Stripe (cash, check, bank transfer, etc.).

Authorization

apiKey

AuthorizationBearer <token>

API key issued from your AgentInvoice account settings.

In: header

Path Parameters

id*integer

Invoice ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

paymentMethod*string

Method used for payment. 'cash' = cash payment, 'check' = cheque, 'other' = any other method

Value in"cash" | "check" | "other"

note?string

Optional note about the payment

Response Body

`application/json`

curl -X POST "https://app.agentinvoice.co/api/invoices/0/mark-paid" \  -H "Content-Type: application/json" \  -d '{    "paymentMethod": "cash"  }'

{
  "id": 101,
  "clientId": 42,
  "invoiceNumber": "INV-0042",
  "status": "draft",
  "currency": "USD",
  "subtotal": "1500.00",
  "taxTotal": "150.00",
  "total": "1650.00",
  "amountPaid": "0.00",
  "notes": "string",
  "terms": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "issueDate": "2019-08-24T14:15:22Z",
  "sentAt": "2019-08-24T14:15:22Z",
  "paidAt": "2019-08-24T14:15:22Z",
  "publicToken": "string",
  "clientName": "string",
  "clientEmail": "string",
  "lineItems": [
    {
      "id": 1,
      "description": "Web development - 10 hours",
      "quantity": "10.00",
      "unitPrice": "150.00",
      "taxRate": "0.10",
      "amount": "1500.00",
      "sortOrder": 0
    }
  ],
  "stripePaymentLink": "string",
  "stripeCheckoutSessionId": "string",
  "spiffyPaymentLink": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}