OpenAPI Specification
openapi: 3.0.3
info:
title: Ordway REST Billing Runs Debit Memos API
description: RESTful API for bidirectional integration with the Ordway billing and revenue automation platform. Enables managing customers, subscriptions, invoices, payments, usage data, and revenue recognition schedules. Supports usage-based billing, ASC 606 compliant revenue recognition, accounts receivable automation, and SaaS metrics reporting.
version: v1
contact:
name: Ordway Support
url: https://support.ordwaylabs.com
termsOfService: https://ordwaylabs.com/
servers:
- url: https://api.ordwaylabs.com/api/v1
description: Production
- url: https://staging.ordwaylabs.com/api/v1
description: Staging
security:
- ApiKeyAuth: []
UserTokenAuth: []
UserEmailAuth: []
CompanyAuth: []
tags:
- name: Debit Memos
description: Manage debit memos
paths:
/debit_memos:
get:
summary: List debit memos
operationId: listDebitMemos
tags:
- Debit Memos
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/size'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: List of debit memos
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DebitMemo'
'401':
$ref: '#/components/responses/Unauthorized'
/debit_memos/{id}:
get:
summary: Retrieve a debit memo
operationId: getDebitMemo
tags:
- Debit Memos
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: Debit memo details
content:
application/json:
schema:
$ref: '#/components/schemas/DebitMemo'
'404':
$ref: '#/components/responses/NotFound'
components:
parameters:
id:
name: id
in: path
required: true
description: Resource identifier
schema:
type: string
size:
name: size
in: query
description: Number of records per page
schema:
type: integer
minimum: 1
maximum: 500
default: 50
page:
name: page
in: query
description: Page number for pagination (1-based)
schema:
type: integer
minimum: 1
default: 1
sort:
name: sort
in: query
description: Comma-separated list of fields to sort by (prefix with - for descending)
schema:
type: string
schemas:
DebitMemo:
type: object
required:
- company_id
- debit_memo_id
properties:
company_id:
type: string
debit_memo_id:
type: string
customer_id:
type: string
status:
type: string
nullable: true
debit_date:
type: string
format: date
nullable: true
debit_amount:
type: number
nullable: true
balance:
type: number
nullable: true
paid_amount:
type: number
nullable: true
notes:
type: string
nullable: true
currency:
type: string
nullable: true
debit_tax:
type: number
nullable: true
subtotal:
type: number
nullable: true
debit_pdf_url:
type: string
format: uri
nullable: true
custom_fields:
type: object
nullable: true
additionalProperties: true
created_by:
type: string
nullable: true
updated_by:
type: string
nullable: true
created_date:
type: string
format: date-time
nullable: true
updated_date:
type: string
format: date-time
nullable: true
Error:
type: object
properties:
error:
type: string
errors:
type: object
additionalProperties: true
responses:
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: Authentication credentials missing or invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
description: Ordway API key
UserTokenAuth:
type: apiKey
in: header
name: X-User-Token
description: Ordway user authentication token
UserEmailAuth:
type: apiKey
in: header
name: X-User-Email
description: Ordway user email address
CompanyAuth:
type: apiKey
in: header
name: X-User-Company
description: Ordway company identifier
externalDocs:
description: Ordway API Documentation
url: https://ordwaylabs.stoplight.io/docs/ordway/ZG9jOjQ4OTgxNg-overview