Create Invoice Payment | Coperniq API

const url = 'https://api.coperniq.io/v1/invoices/1/payments';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"amount":1.1,"paymentMethod":"CASH","paymentDate":"2024-01-15T09:30:00Z"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": 1,
  "amount": 1.1,
  "status": "string",
  "paymentMethod": "CASH",
  "invoiceNumber": 1,
  "paymentDate": "2024-01-15T09:30:00Z",
  "paymentReference": "string",
  "notes": "string",
  "isExternal": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "createdBy": {
    "id": 1,
    "firstName": "string",
    "lastName": "string"
  }
}

Record a manual payment against an invoice.

Request body

amount: Positive number in dollars
paymentDate: ISO 8601 datetime string
paymentMethod: One of CASH, ACH, CREDIT_CARD, KLARNA, AFFIRM, CHECK
notes (optional)
paymentReference (optional)

Record a manual payment against an invoice. **Request body** - `amount`: Positive number in **dollars** - `paymentDate`: ISO 8601 datetime string - `paymentMethod`: One of `CASH`, `ACH`, `CREDIT_CARD`, `KLARNA`, `AFFIRM`, `CHECK` - `notes` (optional) - `paymentReference` (optional)

Authentication

x-api-keystring

API Key authentication via header

Path parameters

invoice_idintegerRequired

Invoice identifier

Request

This endpoint expects an object.

amountdoubleRequired

Payment amount in dollars

paymentMethodenumRequired

Payment method

paymentDatestringRequiredformat: "date-time"

notesstringOptional

Optional notes about the payment

paymentReferencestring or nullOptional

Response

Payment created successfully

idinteger

Payment record identifier

amountdouble

Payment amount in dollars

statusstring

Payment status

paymentMethodenum

Payment method

invoiceNumberinteger or nullOptional

Payment display number (when present)

paymentDatestring or nullOptionalformat: "date-time"

When the payment was recorded (ISO 8601); null if absent from upstream

paymentReferencestring or nullOptional

notesstring or nullOptional

isExternalboolean or nullOptional

Whether the payment originated from an external processor (e.g. Stripe)

createdAtstring or nullOptionalformat: "date-time"

updatedAtstring or nullOptionalformat: "date-time"

createdByobject or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error