invoicepdfs-com Customers API
The customers API from invoicepdfs-com — 2 operation(s) for customers.
The customers API from invoicepdfs-com — 2 operation(s) for customers.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/invoicepdfs-com:invoicepdfs-com-customers-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Invoicepdfs Com Customers API
version: 0.3.0
contact:
name: InvoicePDFs
url: https://invoicepdfs.com/
license:
name: MIT
description: 'Operations tagged customers across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Customers
paths:
/api/v1/customers:
get:
tags:
- Customers
summary: List Customers
description: 'The people and companies you bill, newest first.
Cursor-paginated. A customer is optional — the stateless render endpoints take
a buyer inline — but storing one lets a document reference it by id.'
operationId: list_customers
security:
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
maximum: 100
minimum: 1
default: 50
title: Limit
- name: cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Cursor
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
x-visibility: public
post:
tags:
- Customers
summary: Create Customer
description: 'Store a customer you can bill repeatedly.
`tax_id` and `electronic_address` are what e-invoicing needs: a buyer VAT
number and the Peppol identifier a receiver is addressed by. Neither is
required for a plain PDF.'
operationId: create_customer
security:
- HTTPBearer: []
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Idempotency-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
x-visibility: public
/api/v1/customers/{customer_id}:
get:
tags:
- Customers
summary: Get Customer
description: One stored customer.
operationId: get_customer
security:
- HTTPBearer: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
title: Customer Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
x-visibility: public
patch:
tags:
- Customers
summary: Update Customer
description: 'Change a stored customer.
Only the fields you send are changed — omit one to leave it alone, send
`null` to clear it. Documents already issued keep the details they were
issued with; this does not rewrite them.'
operationId: update_customer
security:
- HTTPBearer: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
title: Customer Id
- name: Idempotency-Key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Idempotency-Key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerPatch'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
x-visibility: public
delete:
tags:
- Customers
summary: Delete Customer
description: 'Remove a customer.
`409` if any document still references them, naming what does. History is
kept rather than rewritten.'
operationId: delete_customer
security:
- HTTPBearer: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
title: Customer Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/SimpleBoolResponse'
'409':
description: The customer is named on documents or recurring invoices. `details.referenced_by` counts each one.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
x-visibility: public
components:
schemas:
CustomersListResponse:
properties:
data:
items:
$ref: '#/components/schemas/CustomerOut'
type: array
title: Data
pagination:
$ref: '#/components/schemas/CursorPagination'
type: object
required:
- data
title: CustomersListResponse
CustomerCreate:
properties:
name:
type: string
title: Name
examples:
- Jane Smith
contact_name:
anyOf:
- type: string
- type: 'null'
title: Contact Name
description: Who to ask about an invoice — a person or a department, not the company. EN 16931 calls it the contact point (BT-41 for the seller, BT-56 for the buyer); some national rulesets require it.
examples:
- Accounts Receivable
email:
anyOf:
- type: string
- type: 'null'
title: Email
examples:
- jane@example.com
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
examples:
- +1-555-987-6543
tax_id:
anyOf:
- type: string
- type: 'null'
title: Tax Id
examples:
- US-EIN-98-7654321
billing_address:
anyOf:
- $ref: '#/components/schemas/PostalAddress'
- type: 'null'
shipping_address:
anyOf:
- $ref: '#/components/schemas/PostalAddress'
- type: 'null'
electronic_address:
anyOf:
- $ref: '#/components/schemas/ElectronicAddress'
- type: 'null'
description: Network address for e-invoicing. Required by Peppol; not the tax id.
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
type: object
required:
- name
title: CustomerCreate
CustomerPatch:
properties:
name:
type: string
title: Name
contact_name:
anyOf:
- type: string
- type: 'null'
title: Contact Name
email:
anyOf:
- type: string
- type: 'null'
title: Email
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
tax_id:
anyOf:
- type: string
- type: 'null'
title: Tax Id
billing_address:
anyOf:
- $ref: '#/components/schemas/PostalAddress'
- type: 'null'
shipping_address:
anyOf:
- $ref: '#/components/schemas/PostalAddress'
- type: 'null'
electronic_address:
anyOf:
- $ref: '#/components/schemas/ElectronicAddress'
- type: 'null'
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
type: object
title: CustomerPatch
PostalAddress:
properties:
line1:
type: string
title: Line1
examples:
- 1 Main St
line2:
anyOf:
- type: string
- type: 'null'
title: Line2
examples:
- Suite 200
city:
anyOf:
- type: string
- type: 'null'
title: City
examples:
- San Francisco
state:
anyOf:
- type: string
- type: 'null'
title: State
examples:
- CA
postal_code:
anyOf:
- type: string
- type: 'null'
title: Postal Code
examples:
- '94105'
country:
anyOf:
- type: string
- type: 'null'
title: Country
examples:
- US
type: object
required:
- line1
title: PostalAddress
CursorPagination:
properties:
has_more:
type: boolean
title: Has More
default: false
next_cursor:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
type: object
title: CursorPagination
CustomerOut:
properties:
name:
type: string
title: Name
examples:
- Jane Smith
contact_name:
anyOf:
- type: string
- type: 'null'
title: Contact Name
description: Who to ask about an invoice — a person or a department, not the company. EN 16931 calls it the contact point (BT-41 for the seller, BT-56 for the buyer); some national rulesets require it.
examples:
- Accounts Receivable
email:
anyOf:
- type: string
- type: 'null'
title: Email
examples:
- jane@example.com
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
examples:
- +1-555-987-6543
tax_id:
anyOf:
- type: string
- type: 'null'
title: Tax Id
examples:
- US-EIN-98-7654321
billing_address:
anyOf:
- $ref: '#/components/schemas/PostalAddress'
- type: 'null'
shipping_address:
anyOf:
- $ref: '#/components/schemas/PostalAddress'
- type: 'null'
electronic_address:
anyOf:
- $ref: '#/components/schemas/ElectronicAddress'
- type: 'null'
description: Network address for e-invoicing. Required by Peppol; not the tax id.
metadata:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Metadata
id:
type: string
title: Id
created_at:
type: string
title: Created At
updated_at:
type: string
title: Updated At
type: object
required:
- name
- id
- created_at
- updated_at
title: CustomerOut
SimpleBoolResponse:
properties:
data:
additionalProperties:
type: boolean
type: object
title: Data
type: object
required:
- data
title: SimpleBoolResponse
description: 'Generic boolean response envelope.
Example:
{"data": {"deleted": true}}'
CustomerResponse:
properties:
data:
$ref: '#/components/schemas/CustomerOut'
type: object
required:
- data
title: CustomerResponse
ApiErrorResponse:
type: object
title: ApiErrorResponse
properties:
error:
type: object
properties:
status:
type: integer
example: 422
description: HTTP status, mirroring the response status line.
code:
type: string
example: unprocessable_entity
message:
type: string
example: Request validation failed
request_id:
type: string
nullable: true
description: Trace id for this request; also returned as X-Trace-Id.
details:
type: object
nullable: true
description: Error-specific context. Validation failures carry `fields`.
required:
- status
- code
- message
required:
- error
ElectronicAddress:
properties:
value:
type: string
minLength: 1
title: Value
examples:
- '9482348239'
scheme_id:
type: string
minLength: 1
title: Scheme Id
description: EAS code list identifier — 0088 is GLN, 9930 a German VAT number.
examples:
- 0088
type: object
required:
- value
- scheme_id
title: ElectronicAddress
description: 'BT-34 / BT-49 — where a document is routed on Peppol or DBNA.
Both halves are required: an identifier without its scheme cannot be
resolved, because the same string means different things in different code
lists. This is not the tax id, which identifies a company to a tax
authority rather than a mailbox on a network.'
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs