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

Tabs Credit Memos API

The Credit Memos API from Tabs — 3 operation(s) for credit memos.

Tabs Credit Memos API is one of 23 APIs that Tabs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 4 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://integrators.prod.api.tabsplatform.com.

4 operations 3 paths 14 schemas 2 GET2 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://integrators.prod.api.tabsplatform.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Tabs Credit Memos API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (custom-header). By default, every request must be authenticated.

Paths & Operations 4

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

Credit Memos 4
GET
/v3/credit-memos/{id}
Get credit memo by ID
IntegratorsApiCreditMemosController_getCreditMemo 1 param → 200404500
GET
/v3/credit-memos
List credit memos
IntegratorsApiCreditMemosController_getCreditMemos 3 params → 200
POST
/v3/credit-memos
Create credit memo
IntegratorsApiCreditMemosController_createCreditMemo body → 201400500
POST
/v3/credit-memos/{id}/applications
Apply credit memo
IntegratorsApiCreditMemosController_applyCreditMemo 1 param body → 201400404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are CreditMemoDto (17 properties), CreditMemoLineItemDto (9 properties), CreditMemoApplicationDto (7 properties), CreateCreditMemoRequestDto (6 properties). Each schema is shown below with its type and property counts.

CreateCreditMemoItemDto
object
4 properties 2 required
ApplyOnCreateDto
object
1 property
CreditMemoLineItemDto
object
9 properties 6 required
CreditMemoExternalIdDto
object
2 properties 2 required
ApplyCreditMemoRequestDto
object
2 properties 1 required
CreditMemoErpClassDto
object
2 properties 2 required
CreditMemoApplicationDto
object
7 properties 7 required
IntegratorsApiResponse
object
4 properties 4 required
CreditMemoCustomerDto
object
3 properties 2 required
CreateCreditMemoRequestDto
object
6 properties 4 required
IntegratorsApiError
object
3 properties 2 required
CreditMemoDto
object
17 properties 15 required
PaginatedResponseDTO
object
CreditMemoItemDto
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabs-credit-memos-api-openapi.yml Raw ↑

Other APIs Tabs publishes across the network.

Tabs Billing Terms API
Tabs Categories API
Tabs Classes (QBO only) API
Tabs Commitments API
Tabs Contracts API
Tabs Custom Fields API
Tabs Customers API
Tabs Departments API
Tabs Events API
Tabs Health API
Tabs Invoices API
Tabs Items API