RevKeen Docs
Api reference

Upsert invoice by external ID

Create or update an invoice identified by external source and ID. Used by integrations (PracticeHub, Wodify) to sync invoices.

Related endpoints

  • PUT /invoices/external/batch — Batch upsert invoices by external ID
  • GET /invoices — List invoices
  • POST /invoices — Create invoice
  • GET /invoices/{id} — Get invoice
  • PATCH /invoices/{id} — Update invoice
  • DELETE /invoices/{id} — Delete invoice
  • POST /invoices/{id}/refund — Refund invoice
  • POST /invoices/{id}/reject — Reject invoice

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 409 conflict — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
  • 422 unprocessable_entity — business-rule failure (for example, refunding more than the original charge).

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

PUT
/invoices/external/{source}/{externalId}

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

source*string

External source identifier (e.g., practicehub, wodify)

externalId*string

External ID from the source system

Request Body

application/json

Invoice data for upsert. external_id and external_source are set from path params.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://api.revkeen.com/v2/invoices/external/practicehub/INV-12345" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "customer_external_ref": {      "source": "string",      "id": "string"    },    "customer_uuid": "00000000-0000-0000-0000-000000000000",    "invoice_number": "string",    "total_minor": 0,    "subtotal_minor": 0,    "tax_minor": 0,    "discount_minor": 0,    "currency": "USD",    "invoice_date": "string",    "due_date": "string",    "status": "string",    "line_items": [      {        "description": "string",        "quantity": 1,        "unit_amount_minor": 0,        "product_id": "00000000-0000-0000-0000-000000000000"      }    ],    "notes": "string",    "metadata": {},    "custom_fields": {},    "subscription_terms": {      "collection_method": "charge_automatically",      "start_mode": "when_paid",      "start_date": "string",      "duration_type": "until_cancelled",      "duration_count": 12,      "end_date": "string",      "first_payment_behavior": "charge_first_cycle_now"    },    "external_updated_at": "2026-01-01T00:00:00Z",    "external_type": "string"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customer_uuid": "e7eefd45-cb13-4c62-b229-e5bbc1362123",
    "invoice_number": "string",
    "total_minor": 0,
    "currency": "string",
    "allowed_methods": [
      "string"
    ],
    "status": "string",
    "due_date": "string",
    "custom_fields": {},
    "external_source": "practicehub",
    "external_type": "appointment",
    "external_id": "INV-12345",
    "subscription_terms": {
      "collection_method": "charge_automatically",
      "start_mode": "when_paid",
      "start_date": "string",
      "duration_type": "until_cancelled",
      "duration_count": 12,
      "end_date": "string",
      "first_payment_behavior": "charge_first_cycle_now"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "created": true,
  "warnings": [
    "string"
  ],
  "requestId": "string"
}
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customer_uuid": "e7eefd45-cb13-4c62-b229-e5bbc1362123",
    "invoice_number": "string",
    "total_minor": 0,
    "currency": "string",
    "allowed_methods": [
      "string"
    ],
    "status": "string",
    "due_date": "string",
    "custom_fields": {},
    "external_source": "practicehub",
    "external_type": "appointment",
    "external_id": "INV-12345",
    "subscription_terms": {
      "collection_method": "charge_automatically",
      "start_mode": "when_paid",
      "start_date": "string",
      "duration_type": "until_cancelled",
      "duration_count": 12,
      "end_date": "string",
      "first_payment_behavior": "charge_first_cycle_now"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "created": true,
  "warnings": [
    "string"
  ],
  "requestId": "string"
}
Empty
Empty
Empty
Edit on GitHub