How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Payt invoices API

Operations about invoices

Payt invoices API is one of 20 APIs that Payt publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invoices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 7 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.paytsoftware.com, https://demo-api.paytsoftware.com.

7 operations 5 paths 11 schemas 3 GET3 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.paytsoftware.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Payt invoices API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth2 access token or static API token. See [Authorization](/authentication/authorization) for how to obtain one.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 3 GET, 3 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

invoices 7

Operations about invoices

PATCH
/v1/invoices/block
Block invoices
patchV1InvoicesBlock body → 200401403
POST
/v1/invoices
Upsert invoices in bulk
postV1Invoices body → 201401403
PATCH
/v1/invoices
Update administration invoices
patchV1Invoices body → 200401403
GET
/v1/invoices
Get administration invoices
getV1Invoices 16 params → 200401403
GET
/v1/invoices/deleted
Get invoices deleted in the last 90 days
getV1InvoicesDeleted 5 params → 200401403
PATCH
/v1/invoices/resume
Resume invoices that are blocked through the API
patchV1InvoicesResume body → 200401403
GET
/v1/invoices/{id}
Get administration invoice by id
getV1InvoicesId 4 params → 200401403

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CustomerApi_V1_InvoiceEntity (60 properties), CustomerApi_V1_InvoiceLineEntity (10 properties), CustomerApi_V1_DeletedInvoiceEntity (6 properties), CustomerApi_SuccessEntity (4 properties). Each schema is shown below with its type and property counts.

CustomerApi_V1_LabelEntity
object
1 property 1 required
CustomerApi_V1_InvoiceEntity
object
CustomerApiV1InvoiceEntity model
60 properties 15 required
CustomerApi_ErrorEntity
object
CustomerApiErrorEntity model
2 properties 2 required
CustomerApi_SuccessEntity
object
CustomerApiSuccessEntity model
4 properties 3 required
patchV1Invoices
object
Update administration invoices
2 properties 2 required
CustomerApi_V1_InvoiceLineEntity
object
10 properties 10 required
CustomerApi_V1_DeletedInvoiceEntity
object
6 properties 6 required
postV1Invoices
object
Upsert invoices in bulk
2 properties 2 required
CustomerApi_PaginationEntity
object
1 property 1 required
CustomerApi_InvoicesPageEntity
object
CustomerApiInvoicesPageEntity model
2 properties 1 required
CustomerApi_DeletedInvoicesPageEntity
object
CustomerApiDeletedInvoicesPageEntity model
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payt-invoices-api-openapi.yml Raw ↑

Other APIs Payt publishes across the network.

Payt administrations API
Payt companies API
Payt contacts API
Payt credit_cases API
Payt debtors API
Payt files API
Payt messages API
Payt notes API
Payt notifications API
Payt order_lines API
Payt orders API
Payt payment_conditions API
Where this information came from

This is an independent, third-party profile of Payt invoices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.