Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workiz Payments API

Payments recorded against a job.

Workiz Payments API is one of 5 APIs that Workiz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.workiz.com/api/v1/{api_token}.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.workiz.com/api/v1
Contact
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 1

Payments recorded against a job.

POST
/job/addPayment/{UUID}/
Add a payment to a job
addJobPayment 1 param body → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are PaymentInput (4 properties), Error (3 properties), PaymentResponse (2 properties). Each schema is shown below with its type and property counts.

PaymentInput
object
Payment recorded against a job. Modeled fields - Workiz confirms the addPayment operation; the exact body is gated behind the developer portal.
4 properties 1 required
PaymentResponse
object
2 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workiz-payments-api-openapi.yml Raw ↑

Other APIs Workiz publishes across the network.

Workiz Jobs API
Workiz Leads API
Workiz Team API
Workiz Time Off API