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 Customers API

The Customers API from Tabs — 21 operation(s) for customers.

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

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

This API exposes 24 operations across 21 paths, and defines 46 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.

24 operations 21 paths 46 schemas 1 DELETE7 GET3 PATCH8 POST5 PUT

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 Customers 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 24

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

Customers 24
GET
/v3/customers/{id}
Get customer by ID
IntegratorsApiCustomersController_getCustomerById 1 param → 200404
DELETE
/v3/customers/{id}
Delete customer
IntegratorsApiCustomersController_deleteCustomer 1 param → 200404
GET
/v3/customers
List customers
IntegratorsApiCustomersController_getCustomers 3 params → 200
POST
/v3/customers
Create customer
IntegratorsApiCustomersController_createCustomer body → 202500
POST
/v3/customers/{id}/sub-customers
Create sub-customer
IntegratorsApiCustomersController_createSubCustomer 1 param body → 201500
GET
/v3/customers/{id}/invoices/{invoiceId}
Get customer invoice by ID
IntegratorsApiCustomersController_getInvoice 2 params → 200404
PATCH
/v3/customers/{id}/invoices/{invoiceId}/external-ids
Update invoice external IDs
IntegratorsApiCustomersController_updateInvoiceExternalIds 2 params body → 200404
GET
/v3/customers/{id}/invoices/{invoiceId}/pdf
Download invoice PDF
IntegratorsApiCustomersController_getInvoiceAsPdf 3 params → 200
POST
/v3/customers/{id}/invoices/{invoiceId}/actions
Perform invoice action
IntegratorsApiCustomersController_invoiceActions 2 params body → 200201400500
GET
/v3/customers/{id}/invoices/{invoiceId}/payments/{paymentId}
Get invoice payment by ID
IntegratorsApiCustomersController_getPayment 3 params → 200404
POST
/v3/customers/{id}/invoices/{invoiceId}/payments
Create invoice payment
IntegratorsApiCustomersController_createPayment 2 params body → 200
POST
/v3/customers/{id}/invoices/{invoiceId}/attachments
Upload invoice attachment
IntegratorsApiCustomersController_uploadAttachmentToInvoice 2 params body → 200404500
PUT
/v3/customers/{id}/autocharge
Update customer auto-charge
IntegratorsApiCustomersController_updateCustomerAutoCharge 1 param body → 200404500
PUT
/v3/customers/{id}/cc-fees-exemption
Update customer credit card fees exemption
IntegratorsApiCustomersController_updateCustomerCCFeesExemption 1 param body → 200404500
PUT
/v3/customers/{id}/custom-field
Update customer custom fields
IntegratorsApiCustomersController_updateCustomerCustomField 1 param body → 200400404500
POST
/v3/customers/{id}/contacts
Create customer contacts
IntegratorsApiCustomersController_createContacts 1 param body → 200400404500
GET
/v3/customers/{id}/contacts
List customer contacts
IntegratorsApiCustomersController_getContacts 4 params → 200404500
POST
/v3/customers/{id}/address
Create customer address
IntegratorsApiCustomersController_createAddress 1 param body → 200400404500
PATCH
/v3/customers/{id}/contacts/{contactId}
Update customer contact
IntegratorsApiCustomersController_updateContact 2 params body → 200400404500
POST
/v3/customers/{id}/external-ids
Upsert customer external ID
IntegratorsApiCustomersController_upsertCustomerExternalId 1 param body → 200400404
GET
/v3/customers/{id}/invoices/{invoiceId}/credit-memos
List invoice credit memos
IntegratorsApiCustomersController_getCreditMemosByInvoice 2 params → 200404500
PATCH
/v3/customers/{id}/name
Update customer name
IntegratorsApiCustomersController_updateCustomerName 1 param body → 200400404500
PUT
/v3/customers/{id}/invoices/{invoiceId}/po
Update invoice PO number
IntegratorsApiCustomersController_updateInvoicePO 2 params body → 200404500
PUT
/v3/customers/{id}/invoices/{invoiceId}/memo
Update invoice memo
IntegratorsApiCustomersController_updateInvoiceMemo 2 params body → 200404500

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are InvoiceV3Dto (22 properties), CreditMemoDto (17 properties), CustomerV3Dto (15 properties), PaymentsV3Dto (10 properties). Each schema is shown below with its type and property counts.

UpdateCustomerCCFeesExemptionV3Dto
object
1 property 1 required
CreditMemoExternalIdDto
object
2 properties 2 required
CreditMemoApplicationDto
object
7 properties 7 required
UpdateInvoicePODto
object
1 property 1 required
UpdateContactV3Dto
object
5 properties
CreateContactV3Dto
object
3 properties 1 required
SendInvoiceDto
object
4 properties 3 required
ContactV3Dto
object
6 properties 4 required
CreateCustomerV3Dto
object
7 properties 1 required
ExternalIdSourceType
string
IntegrationsExternalId
object
2 properties 2 required
CreateCustomerErpCustomFieldV3Dto
object
2 properties 2 required
PurchaseOrderDto
object
2 properties 2 required
MarkInvoiceToSentOffTabsDto
object
2 properties 2 required
CreditMemoItemDto
object
3 properties 2 required
CreateAddressV3Dto
object
7 properties 4 required
InvoiceV3Dto
object
22 properties 17 required
CreditMemoLineItemDto
object
9 properties 6 required
ExternalIdV3Dto
object
2 properties 2 required
CreditMemoErpClassDto
object
2 properties 2 required
UpdateInvoiceExternalIdsDto
object
1 property 1 required
AddressV3Dto
object
8 properties 6 required
UpsertCustomerExternalIdV3Dto
object
2 properties 2 required
CreditMemoCustomerDto
object
3 properties 2 required
IntegratorsApiError
object
3 properties 2 required
ItemV3Dto
object
4 properties 3 required
PaginatedResponseDTO
object
UpsertAddressV3Dto
object
9 properties 6 required
CreateSubCustomerDto
object
5 properties 3 required
SendReminderEmailDto
object
2 properties 2 required
CustomerV3Dto
object
15 properties 8 required
MarkInvoiceAsPendingDto
object
2 properties 2 required
InvoiceExternalIdV3Dto
object
2 properties 2 required
IntegratorsApiResponse
object
4 properties 4 required
MarkInvoiceAsVoidDto
object
2 properties 2 required
PaymentsV3Dto
object
10 properties 8 required
UpdateCustomerCustomFieldV3Dto
object
3 properties 1 required
UpdateCustomerAutoChargeV3Dto
object
1 property 1 required
MarkInvoiceAsScheduledDto
object
2 properties 2 required
UpdateInvoiceMemoBodyDto
object
1 property 1 required
CustomerTaxInfoV3Dto
object
3 properties 1 required
InvoiceItemV3Dto
object
10 properties 10 required
UpdateInvoicePOResponseDto
object
4 properties 4 required
UpdateInvoiceMemoResponseDto
object
4 properties 4 required
CreditMemoDto
object
17 properties 15 required
CreatePaymentV3Dto
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabs-customers-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 Credit Memos API
Tabs Custom Fields API
Tabs Departments API
Tabs Events API
Tabs Health API
Tabs Invoices API
Tabs Items API