API docs by Redocly

smartpublisher (1.0.0)

Download OpenAPI specification:

License: ISC

Subscriptions

GetSubscriptions

Authorizations:
personalAccessTokenserviceToken
query Parameters
page
number <double>
pageSize
number <double>
accountId
string
publicationId
string
status
string
includeDeleted
boolean

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0.1,
  • "pageSize": 0.1,
  • "total": 0.1
}

GetSubscriptionById

Authorizations:
personalAccessTokenserviceToken
path Parameters
subscriptionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "subscriptionId": "string",
  • "accountId": "string",
  • "publicationId": "string",
  • "renewedFromSubsId": "string",
  • "renewalDate": "string",
  • "status": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "expireDate": "string",
  • "firstRunDate": "string",
  • "subscriptionNumber": "string",
  • "copies": "string",
  • "autoReschedule": true,
  • "autoInvoice": true,
  • "notes": "string",
  • "totalNetCharge": "string",
  • "totalApplied": "string",
  • "totalDue": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "deletedAt": "string"
}

Publications

GetPublications

Authorizations:
personalAccessTokenserviceToken
query Parameters
page
number <double>
pageSize
number <double>
search
string
isActive
boolean

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0.1,
  • "pageSize": 0.1,
  • "total": 0.1
}

GetPublicationById

Authorizations:
personalAccessTokenserviceToken
path Parameters
publicationId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "name": "string",
  • "isActive": true,
  • "frequency": "string",
  • "issFrequency": "string",
  • "issueDecimals": 0.1,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Invoices

GetInvoices

Authorizations:
personalAccessTokenserviceToken
query Parameters
page
number <double>
pageSize
number <double>
accountId
string
publicationId
string
status
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0.1,
  • "pageSize": 0.1,
  • "total": 0.1
}

GetInvoiceById

Authorizations:
personalAccessTokenserviceToken
path Parameters
invoiceId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "accountId": "string",
  • "publicationId": "string",
  • "issueId": "string",
  • "status": "string",
  • "issueDate": "string",
  • "dueDate": "string",
  • "terms": "string",
  • "total": "string",
  • "totalDue": "string",
  • "balanceCents": 0.1,
  • "gross": "string",
  • "net": "string",
  • "invoiceType": "string",
  • "invoiceDescription": "string",
  • "invCharges": "string",
  • "invInvoiced": "string",
  • "invApplied": "string",
  • "invDiscount": "string",
  • "invTax": "string",
  • "datePaid": "string",
  • "isOpen": 0.1,
  • "notes": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Contacts

GetContacts

Authorizations:
personalAccessTokenserviceToken
query Parameters
page
number <double>
pageSize
number <double>
accountId
string
search
string
includeHidden
boolean
includeSubsOnly
boolean
includeDeleted
boolean

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0.1,
  • "pageSize": 0.1,
  • "total": 0.1
}

CreateContactRecord

Authorizations:
personalAccessTokenserviceToken
Request Body schema: application/json
required
accountId
required
string
name
string or null
firstName
string or null
lastName
string or null
phone
string or null
phone2
string or null
extension
string or null
hideContact
boolean or null
subsOnly
boolean or null
doNotEmail
boolean or null
email
string or null
title
string or null
notes
string or null
deletedAt
string or null

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "phone2": "string",
  • "extension": "string",
  • "hideContact": true,
  • "subsOnly": true,
  • "doNotEmail": true,
  • "email": "string",
  • "title": "string",
  • "notes": "string",
  • "deletedAt": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "accountId": "string",
  • "ownerId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "phone2": "string",
  • "extension": "string",
  • "hideContact": true,
  • "subsOnly": true,
  • "doNotEmail": true,
  • "email": "string",
  • "title": "string",
  • "notes": "string",
  • "deletedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

GetContactById

Authorizations:
personalAccessTokenserviceToken
path Parameters
contactId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "accountId": "string",
  • "ownerId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "phone2": "string",
  • "extension": "string",
  • "hideContact": true,
  • "subsOnly": true,
  • "doNotEmail": true,
  • "email": "string",
  • "title": "string",
  • "notes": "string",
  • "deletedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

UpdateContactRecord

Authorizations:
personalAccessTokenserviceToken
path Parameters
contactId
required
string
Request Body schema: application/json
required
accountId
required
string
name
string or null
firstName
string or null
lastName
string or null
phone
string or null
phone2
string or null
extension
string or null
hideContact
boolean or null
subsOnly
boolean or null
doNotEmail
boolean or null
email
string or null
title
string or null
notes
string or null
deletedAt
string or null

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "phone2": "string",
  • "extension": "string",
  • "hideContact": true,
  • "subsOnly": true,
  • "doNotEmail": true,
  • "email": "string",
  • "title": "string",
  • "notes": "string",
  • "deletedAt": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "accountId": "string",
  • "ownerId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "phone2": "string",
  • "extension": "string",
  • "hideContact": true,
  • "subsOnly": true,
  • "doNotEmail": true,
  • "email": "string",
  • "title": "string",
  • "notes": "string",
  • "deletedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

DeleteContactRecord

Authorizations:
personalAccessTokenserviceToken
path Parameters
contactId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "accountId": "string",
  • "ownerId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "phone2": "string",
  • "extension": "string",
  • "hideContact": true,
  • "subsOnly": true,
  • "doNotEmail": true,
  • "email": "string",
  • "title": "string",
  • "notes": "string",
  • "deletedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

RestoreContactRecord

Authorizations:
personalAccessTokenserviceToken
path Parameters
contactId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "accountId": "string",
  • "ownerId": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "phone2": "string",
  • "extension": "string",
  • "hideContact": true,
  • "subsOnly": true,
  • "doNotEmail": true,
  • "email": "string",
  • "title": "string",
  • "notes": "string",
  • "deletedAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Accounts

GetAccounts

Authorizations:
personalAccessTokenserviceToken
query Parameters
page
number <double>
pageSize
number <double>
search
string
status
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0.1,
  • "pageSize": 0.1,
  • "total": 0.1
}

GetAccountById

Authorizations:
personalAccessTokenserviceToken
path Parameters
accountId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "accountId": "string",
  • "company": "string",
  • "address": "string",
  • "suite": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "webAddress": "string",
  • "status": "string",
  • "billingEmail": "string",
  • "invoiceEmailEnabled": true,
  • "invoicePrintEnabled": true,
  • "doNotEmail": true,
  • "createdAt": "string",
  • "updatedAt": "string"
}