Introduction Ask Anything

Space Invoices API

Health Controller.live

Health Controller.ready

v1-accounts-count

Account Controller.count

Account Controller.find

v1-documents-{shareableId}-payment-intent

Document Payment Intent Controller.get

v1-documents-{shareableId}-stripe-connect-payment-intent

Document Stripe Connect Payment Intent Controller.get

v1-fattura-pa-webhooks

Fattura Pa Controller.webhooks

v1-organizations-{organizationId}-atcud-{id}

Atcud Series Controller.find By Id

v1-organizations-{organizationId}-atcud

Atcud Series Controller.create Atcud Series Controller.find

v1-organizations-{id}-merchant-link

Organization Merchant Link Controller.get

v1-organizations-{id}-merchant

Organization Merchant Controller.create Organization Merchant Controller.patch Organization Merchant Controller.get

v1-organizations-{id}-payment-intents-authorized

Organization Payment Intent Controller.create Authorized

v1-organizations-{id}-payment-intents

Organization Payment Intent Controller.create Organization Payment Intent Controller.find

v1-organizations-{id}-saft-pt-report

Saft Pt Controller.generate Saft Pt

v1-organizations-{id}-stripe-connect-account-link

Organization Stripe Connect Account Link Controller.get

v1-organizations-{id}-stripe-connect-account

Organization Stripe Connect Account Controller.create Organization Stripe Connect Account Controller.find

v1-organizations-{id}-transactions

Organization Transaction Controller.find

v1-payment-processing-webhooks

Payment Processing Controller.webhooks

v1-payment-processing

Account Payment Processing Controller.create Account Payment Processing Controller.patch Account Payment Processing Controller.get

v1-stripe-connect-accounts-{id}

Stripe Connect Account Controller.update By Id

v1-stripe-connect-{id}-webhooks

Stripe Connect Controller.webhooks

v1-stripe-connect

Account Stripe Connect Controller.create Account Stripe Connect Controller.patch Account Stripe Connect Controller.get

v1-Documents-{id}-recurrence

Fetches hasOne relation recurrence.Creates a new instance in recurrence of this model.

v1-Documents-{id}-comments-{fk}

Delete a related item by id for comments.Update a related item by id for comments.

v1-Documents-{id}-comments

Creates a new instance in comments of this model.

v1-Documents-{id}-payments-count

Counts payments of Document.

v1-Documents-{id}-payments

Queries payments of Document.Creates a new instance in payments of this model.

v1-Documents-{id}-documentCategories

Creates a new instance in documentCategories of this model.

v1-Documents-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Documents-{id}-send

Document.prototype.remote Send

v1-Documents-{id}-cancel

Document.prototype.cancel

v1-Documents-{id}-uncancel

Document.prototype.uncancel

v1-Documents-{id}-fiscally-verify

Fiscally verify a document that previously failed verification.

v1-Documents-{id}-e-slog

Generates eslog xml and returns it

v1-Documents-{id}-pdf

Retrieve PDF of document

v1-Documents-{id}-mark-sent

Mark document as sent via snail mail

v1-Documents-{id}-attachments-upload

Uploads an attachment for a document

v1-Documents-{id}-share

Generates and returns shareable document id that allows access to document without authentication

v1-Documents-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Documents-parse-xml

Takes an xml file and returns a json object prepared for saving a document.

v1-Documents-cron-outgoing

Document.remote Overdue Outgoing Cron

v1-Documents-cron-incoming

Document.remote Overdue Incoming Cron

v1-Documents-public-{id}-e-slog

Generates eslog xml from shareableId and returns it

v1-Documents-public-{id}-pdf

Retrieve PDF of document

v1-Documents-public-{id}-attachments-{attachmentId}-download

Retrieve attachment of document by shareable id

v1-Documents-public-{id}

Retrieve document using shareable id

v1-Items-{id}-components-{fk}

Update a related item by id for components.

v1-Items-{id}-components

Creates a new instance in components of this model.

v1-Items-{id}-inventories

Queries inventories of Item.

v1-Items-{id}-replace

Replace attributes for a model instance and persist it into the data source.

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Taxes-{id}-taxRates-{fk}

Delete a related item by id for taxRates.

v1-Taxes-{id}-taxRates

Creates a new instance in taxRates of this model.

v1-Taxes-{id}-replace

Replace attributes for a model instance and persist it into the data source.

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Taxes-clause-type

Tax.remote Tax Clause Type

v1-Clients-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Clients-{id}-send-reminder

Client.prototype.remote Send Overdue Reminder

v1-Clients-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Organizations-{id}-defaults-{fk}

Update a related item by id for _defaults.

v1-Organizations-{id}-defaults-count

Counts _defaults of Organization.

v1-Organizations-{id}-defaults

Queries _defaults of Organization.Creates a new instance in _defaults of this model.

v1-Organizations-{id}-documents-count

Counts documents of Organization.

v1-Organizations-{id}-documents-pdfs

Get multiple document PDF files in ZIP.

v1-Organizations-{id}-documents-parse-image

Takes an image or PDF file and puts in into processing queue to create document from.

v1-Organizations-{id}-documents

Queries documents of Organization.Creates a new instance in documents of this model.

v1-Organizations-{id}-clients-count

Counts clients of Organization.

v1-Organizations-{id}-clients-search

Organization.prototype.search Clients get Organizations_{id} clients search

v1-Organizations-{id}-clients

Queries clients of Organization.Creates a new instance in clients of this model.

v1-Organizations-{id}-items-count

Counts items of Organization.

v1-Organizations-{id}-items-search

Organization.prototype.search Items get Organizations_{id} items search

v1-Organizations-{id}-items

Queries items of Organization.Creates a new instance in items of this model.

v1-Organizations-{id}-taxes-count

Counts taxes of Organization.

v1-Organizations-{id}-taxes

Queries taxes of Organization.Creates a new instance in taxes of this model.

v1-Organizations-{id}-shopify-count

Counts shopify of Organization.

v1-Organizations-{id}-shopify

Queries shopify of Organization.Creates a new instance in shopify of this model.

v1-Organizations-{id}-stripe-count

Counts stripe of Organization.

v1-Organizations-{id}-stripe

Queries stripe of Organization.Creates a new instance in stripe of this model.

v1-Organizations-{id}-ticketingHub-count

Counts ticketingHub of Organization.

v1-Organizations-{id}-ticketingHub

Queries ticketingHub of Organization.Creates a new instance in ticketingHub of this model.

v1-Organizations-{id}-recurrences-count

Counts recurrences of Organization.

v1-Organizations-{id}-recurrences

Queries recurrences of Organization.

v1-Organizations-{id}-payments-count

Counts payments of Organization.

v1-Organizations-{id}-payments

Queries payments of Organization.Creates a new instance in payments of this model.

v1-Organizations-{id}-businessPremises

Queries businessPremises of Organization.Creates a new instance in businessPremises of this model.

v1-Organizations-{id}-electronicDevices

Queries electronicDevices of Organization.Creates a new instance in electronicDevices of this model.

v1-Organizations-{id}-accountOrganizations-count

Counts accountOrganizations of Organization.

v1-Organizations-{id}-accountOrganizations

Queries accountOrganizations of Organization.

v1-Organizations-{id}-units-count

Counts units of Organization.

v1-Organizations-{id}-units

Queries units of Organization.Creates a new instance in units of this model.

v1-Organizations-{id}-categories-count

Counts categories of Organization.

v1-Organizations-{id}-categories

Queries categories of Organization.Creates a new instance in categories of this model.

v1-Organizations-{id}-documentCategories-count

Counts documentCategories of Organization.

v1-Organizations-{id}-documentCategories

Queries documentCategories of Organization.

v1-Organizations-{id}-priceLists-count

Counts priceLists of Organization.

v1-Organizations-{id}-priceLists

Queries priceLists of Organization.Creates a new instance in priceLists of this model.

v1-Organizations-{id}-warehouses-count

Counts warehouses of Organization.

v1-Organizations-{id}-warehouses

Queries warehouses of Organization.Creates a new instance in warehouses of this model.

v1-Organizations-{id}-webhooks-count

Counts webhooks of Organization.

v1-Organizations-{id}-webhooks

Queries webhooks of Organization.Creates a new instance in webhooks of this model.

v1-Organizations-{id}-orders-count

Counts orders of Organization.

v1-Organizations-{id}-orders

Queries orders of Organization.

v1-Organizations-{id}-magento1-count

Counts magento1 of Organization.

v1-Organizations-{id}-magento1

Queries magento1 of Organization.Creates a new instance in magento1 of this model.

v1-Organizations-{id}-woocommerce-count

Counts woocommerce of Organization.

v1-Organizations-{id}-woocommerce

Queries woocommerce of Organization.Creates a new instance in woocommerce of this model.

v1-Organizations-{id}-customIntegrations-count

Counts customIntegrations of Organization.

v1-Organizations-{id}-customIntegrations

Queries customIntegrations of Organization.Creates a new instance in customIntegrations of this model.

v1-Organizations-{id}-thrivecart-count

Counts thrivecart of Organization.

v1-Organizations-{id}-thrivecart

Queries thrivecart of Organization.Creates a new instance in thrivecart of this model.

v1-Organizations-{id}-bokun-count

Counts bokun of Organization.

v1-Organizations-{id}-bokun

Queries bokun of Organization.Creates a new instance in bokun of this model.

v1-Organizations-{id}-shopamine-count

Counts shopamine of Organization.

v1-Organizations-{id}-shopamine

Queries shopamine of Organization.Creates a new instance in shopamine of this model.

v1-Organizations-{id}-activate

Organization.prototype.req Toggle Active post Organizations_{id} activate

v1-Organizations-{id}-deactivate

Organization.prototype.req Toggle Active post Organizations_{id} deactivate

v1-Organizations-{id}-is-unique-doc-number

Organization.prototype.is Unique Doc Number

v1-Organizations-{id}-last-doc-number

Organization.prototype.last Doc Number

v1-Organizations-{id}-next-doc-number

Organization.prototype.next Doc Number

v1-Organizations-{id}-subscription

Get currenct subscription

v1-Organizations-{id}-search-documents

DEPRECATED: Search documents endpoint

v1-Organizations-{id}-upload-image

Organization.prototype.upload Image post Organizations_{id} upload-image

v1-Organizations-{id}-images-logo

Organization.prototype.download Logo

v1-Organizations-{id}-images

Organization.prototype.upload Image post Organizations_{id} images Organization.prototype.delete Image delete Organizations_{id} images Organization.prototype.download Image get Organizations_{id} images

v1-Organizations-{id}-delete-image

Organization.prototype.delete Image delete Organizations_{id} delete-image

v1-Organizations-{id}-download-image

Organization.prototype.download Image get Organizations_{id} download-image

v1-Organizations-{id}-search-clients

Organization.prototype.search Clients get Organizations_{id} search-clients

v1-Organizations-{id}-search-items

Organization.prototype.search Items get Organizations_{id} search-items

v1-Organizations-{id}-business-stats

Provides business statistics about the given organization for a particular date range

v1-Organizations-{id}-total-stats

Provides financial statistics about the given organization

v1-Organizations-{id}-document-total-stats

Get organization's document stats

v1-Organizations-{id}-category-total-stats

Get organization's categories stats

v1-Organizations-{id}-payment-total-stats

Get organization's payments stats

v1-Organizations-{id}-this-month-invoices

Returns number of invoices issued by organization in this month

v1-Organizations-{id}-export

Organization.prototype.export

v1-Organizations-{id}-upload-certificate

Organization.prototype.upload Certificate

v1-Organizations-{id}-invite

Invite user to / give access to organization

v1-Organizations-{id}-has-certificate

Check if organization has certificate of a type

v1-Organizations-{id}-import

Import CSV data

v1-Organizations-{id}-reports-profit-and-loss

Generate category profit and loss report

v1-Organizations-{id}-reports-balance-sheet

Generate balance sheet balance sheet

v1-Organizations-{id}

Find a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Organizations-mailgun-route

Redirect mailgun to correct model

v1-Shopify-{id}-order

Shopify.prototype.process Order

v1-Shopify-{id}-import

Import integration data in excel format

v1-Shopify-{id}-orders-document

Shopify.prototype.find Order Document

v1-Shopify-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Shopify-incoming

Shopify.incoming

Shopify.application

v1-Stripe-{id}-incoming

Stripe.prototype.incoming

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-TicketingHub-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-TicketingHub-{id}

Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

Find all instances of the model matched by filter from the data source.

v1-Accounts-{id}-accessTokens-{fk}

Delete a related item by id for accessTokens.

v1-Accounts-{id}-accessTokens

Queries accessTokens of Account.Creates a new instance in accessTokens of this model.

v1-Accounts-{id}-usages-count

Counts usages of Account.

v1-Accounts-{id}-usages

Queries usages of Account.

v1-Accounts-{id}-organizations-count

Counts organizations of Account.

v1-Accounts-{id}-organizations

Queries organizations of Account.Creates a new instance in organizations of this model.

v1-Accounts-{id}-logs-count

Counts logs of Account.

v1-Accounts-{id}-logs

Queries logs of Account.

v1-Accounts-{id}-verify

Trigger user's identity verification with configured verifyOptions

v1-Accounts-{id}-is-verified

Check if account is verified.

v1-Accounts-{id}-send-verification

Request another verification email

v1-Accounts-{id}

Find a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Accounts-login

Login a user with username/email and password.

v1-Accounts-logout

Logout a user with access token.

v1-Accounts-confirm

Confirm a user registration with identity verification token.

v1-Accounts-reset

Reset password for a user with email.

v1-Accounts-change-password

Change a user's password.

v1-Accounts-reset-password

Reset user's password via a password-reset token.

v1-Accounts-is-unique

Check if e-mail already exists.

v1-Accounts-impersonate

Login as child account

v1-Accounts-authorized

Checks if user is authorized and returns user

v1-Accounts-identity-verification

Returns identity hash for user

v1-Accounts-subscription

Retrieve Account's active subscription

Create a new instance of the model and persist it into the data source.

v1-Recurrences-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Recurrences-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Recurrences-cron

Recurrence.run Cron

v1-Payments-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Payments-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Defaults-{id}

Find a model instance by {{id}} from the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Companies-search

Find all instances of the model matched by filter from the data source.

v1-Subscriptions-{id}-whiteLabel

Creates a new instance in whiteLabel of this model.

v1-Subscriptions-{id}-payment-method

Get Payment method Add/Update payment method

v1-Subscriptions-client-token

Get Braintree client token

v1-Subscriptions-cron

Subscription.remote Cron

v1-Subscriptions

Find all instances of the model matched by filter from the data source.

Find all instances of the model matched by filter from the data source.

v1-WhiteLabels-{id}

Patch attributes for a model instance and persist it into the data source.

Create a new instance of the model and persist it into the data source.Find all instances of the model matched by filter from the data source.

v1-containers-{container}-download-{file}

container.download

v1-Messages-contact-sales

Message.remote Contact Sales

v1-BusinessPremises-{id}-electronicDevices

Creates a new instance in electronicDevices of this model.

v1-BusinessPremises-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-AtcudSeries-{id}-organization

Fetches belongsTo relation organization.

v1-AtcudSeries-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-AtcudSeries-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-AtcudSeries-findOne

Find first instance of the model matched by filter from the data source.

v1-AtcudSeries-count

Count instances of the model matched by where from the data source.

Create a new instance of the model and persist it into the data source.Find all instances of the model matched by filter from the data source.

Find all instances of the model matched by filter from the data source.

v1-tracking-webhook

Tracking.webhook

v1-ElectronicDevices-{id}

Patch attributes for a model instance and persist it into the data source.

v1-Certificates-expiry-cron

Certificate.remote Expiry Cron

v1-geoip-locate

Parse IP to geo location

v1-AccountOrganizations-{id}-accept

Confirm invitation to join organization

v1-AccountOrganizations-{id}-reject

Deny invitation to join organization

v1-AccountOrganizations-{id}-enable

Enable users access to organization

v1-AccountOrganizations-{id}-disable

Disable users access to organization

v1-AccountOrganizations-{id}-change-role

Account Organization.prototype.change Role

v1-AccountOrganizations-{id}

Delete a model instance by {{id}} from the data source.

v1-FileMeta-{id}

Delete a model instance by {{id}} from the data source.

v1-Units-{id}-last-doc-number

Unit.prototype.last Doc Number

v1-Units-{id}-next-doc-number

Unit.prototype.next Doc Number

v1-Units-{id}-upload-image

Unit.prototype.upload Image post Units_{id} upload-image

v1-Units-{id}-images

Unit.prototype.upload Image post Units_{id} images Unit.prototype.delete Image delete Units_{id} images Unit.prototype.download Image get Units_{id} images

v1-Units-{id}-delete-image

Unit.prototype.delete Image delete Units_{id} delete-image

v1-Units-{id}-download-image

Unit.prototype.download Image get Units_{id} download-image

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Categories-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Categories-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-DocumentCategories-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-DocumentCategories-{id}

Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-PriceLists-{id}-items-count

Counts items of PriceList.

v1-PriceLists-{id}-items

Queries items of PriceList.

v1-PriceLists-{id}-prices-count

Counts prices of PriceList.

v1-PriceLists-{id}-prices

Queries prices of PriceList.Creates a new instance in prices of this model.

v1-PriceLists-{id}

Find a model instance by {{id}} from the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Warehouses-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Warehouses-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Webhooks-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Webhooks-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Typless-webhook

Typless.remote On Webhook

v1-Orders-{id}-documents-create

Order.prototype.remote Create Document

Find a model instance by {{id}} from the data source.

v1-Magento1-{id}-order

Magento1.prototype.process Order

v1-Magento1-{id}-import

Import integration data in excel format

v1-Magento1-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Woocommerce-{id}-order

Woocommerce.prototype.process Order

v1-Woocommerce-{id}-import

Import integration data in excel format

v1-Woocommerce-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-CustomIntegrations-{id}-order

Custom Integration.prototype.process Order

v1-CustomIntegrations-{id}-import

Import integration data in excel format

v1-CustomIntegrations-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Thrivecart-{id}-order

Thrivecart.prototype.process Order Thrivecart.prototype.install

v1-Thrivecart-{id}-import

Import integration data in excel format

v1-Thrivecart-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Bokun-{id}-order

Bokun.prototype.process Order

v1-Bokun-{id}-import

Import integration data in excel format

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Shopamine-{id}-order

Shopamine.prototype.process Order

v1-Shopamine-{id}-import

Import integration data in excel format

v1-Shopamine-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Sendgrid-webhook

Sendgrid.webhook

v1-Logs-cron-clear

v1-AWSSES-webhook

Health Controller.health

Introduction Ask Anything

Space Invoices API

Health Controller.live

Health Controller.ready

v1-accounts-count

Account Controller.count

Account Controller.find

v1-documents-{shareableId}-payment-intent

Document Payment Intent Controller.get

v1-documents-{shareableId}-stripe-connect-payment-intent

Document Stripe Connect Payment Intent Controller.get

v1-fattura-pa-webhooks

Fattura Pa Controller.webhooks

v1-organizations-{organizationId}-atcud-{id}

Atcud Series Controller.find By Id

v1-organizations-{organizationId}-atcud

Atcud Series Controller.create Atcud Series Controller.find

v1-organizations-{id}-merchant-link

Organization Merchant Link Controller.get

v1-organizations-{id}-merchant

Organization Merchant Controller.create Organization Merchant Controller.patch Organization Merchant Controller.get

v1-organizations-{id}-payment-intents-authorized

Organization Payment Intent Controller.create Authorized

v1-organizations-{id}-payment-intents

Organization Payment Intent Controller.create Organization Payment Intent Controller.find

v1-organizations-{id}-saft-pt-report

Saft Pt Controller.generate Saft Pt

v1-organizations-{id}-stripe-connect-account-link

Organization Stripe Connect Account Link Controller.get

v1-organizations-{id}-stripe-connect-account

Organization Stripe Connect Account Controller.create Organization Stripe Connect Account Controller.find

v1-organizations-{id}-transactions

Organization Transaction Controller.find

v1-payment-processing-webhooks

Payment Processing Controller.webhooks

v1-payment-processing

Account Payment Processing Controller.create Account Payment Processing Controller.patch Account Payment Processing Controller.get

v1-stripe-connect-accounts-{id}

Stripe Connect Account Controller.update By Id

v1-stripe-connect-{id}-webhooks

Stripe Connect Controller.webhooks

v1-stripe-connect

Account Stripe Connect Controller.create Account Stripe Connect Controller.patch Account Stripe Connect Controller.get

v1-Documents-{id}-recurrence

Fetches hasOne relation recurrence.Creates a new instance in recurrence of this model.

v1-Documents-{id}-comments-{fk}

Delete a related item by id for comments.Update a related item by id for comments.

v1-Documents-{id}-comments

Creates a new instance in comments of this model.

v1-Documents-{id}-payments-count

Counts payments of Document.

v1-Documents-{id}-payments

Queries payments of Document.Creates a new instance in payments of this model.

v1-Documents-{id}-documentCategories

Creates a new instance in documentCategories of this model.

v1-Documents-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Documents-{id}-send

Document.prototype.remote Send

v1-Documents-{id}-cancel

Document.prototype.cancel

v1-Documents-{id}-uncancel

Document.prototype.uncancel

v1-Documents-{id}-fiscally-verify

Fiscally verify a document that previously failed verification.

v1-Documents-{id}-e-slog

Generates eslog xml and returns it

v1-Documents-{id}-pdf

Retrieve PDF of document

v1-Documents-{id}-mark-sent

Mark document as sent via snail mail

v1-Documents-{id}-attachments-upload

Uploads an attachment for a document

v1-Documents-{id}-share

Generates and returns shareable document id that allows access to document without authentication

v1-Documents-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Documents-parse-xml

Takes an xml file and returns a json object prepared for saving a document.

v1-Documents-cron-outgoing

Document.remote Overdue Outgoing Cron

v1-Documents-cron-incoming

Document.remote Overdue Incoming Cron

v1-Documents-public-{id}-e-slog

Generates eslog xml from shareableId and returns it

v1-Documents-public-{id}-pdf

Retrieve PDF of document

v1-Documents-public-{id}-attachments-{attachmentId}-download

Retrieve attachment of document by shareable id

v1-Documents-public-{id}

Retrieve document using shareable id

v1-Items-{id}-components-{fk}

Update a related item by id for components.

v1-Items-{id}-components

Creates a new instance in components of this model.

v1-Items-{id}-inventories

Queries inventories of Item.

v1-Items-{id}-replace

Replace attributes for a model instance and persist it into the data source.

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Taxes-{id}-taxRates-{fk}

Delete a related item by id for taxRates.

v1-Taxes-{id}-taxRates

Creates a new instance in taxRates of this model.

v1-Taxes-{id}-replace

Replace attributes for a model instance and persist it into the data source.

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Taxes-clause-type

Tax.remote Tax Clause Type

v1-Clients-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Clients-{id}-send-reminder

Client.prototype.remote Send Overdue Reminder

v1-Clients-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Organizations-{id}-defaults-{fk}

Update a related item by id for _defaults.

v1-Organizations-{id}-defaults-count

Counts _defaults of Organization.

v1-Organizations-{id}-defaults

Queries _defaults of Organization.Creates a new instance in _defaults of this model.

v1-Organizations-{id}-documents-count

Counts documents of Organization.

v1-Organizations-{id}-documents-pdfs

Get multiple document PDF files in ZIP.

v1-Organizations-{id}-documents-parse-image

Takes an image or PDF file and puts in into processing queue to create document from.

v1-Organizations-{id}-documents

Queries documents of Organization.Creates a new instance in documents of this model.

v1-Organizations-{id}-clients-count

Counts clients of Organization.

v1-Organizations-{id}-clients-search

Organization.prototype.search Clients get Organizations_{id} clients search

v1-Organizations-{id}-clients

Queries clients of Organization.Creates a new instance in clients of this model.

v1-Organizations-{id}-items-count

Counts items of Organization.

v1-Organizations-{id}-items-search

Organization.prototype.search Items get Organizations_{id} items search

v1-Organizations-{id}-items

Queries items of Organization.Creates a new instance in items of this model.

v1-Organizations-{id}-taxes-count

Counts taxes of Organization.

v1-Organizations-{id}-taxes

Queries taxes of Organization.Creates a new instance in taxes of this model.

v1-Organizations-{id}-shopify-count

Counts shopify of Organization.

v1-Organizations-{id}-shopify

Queries shopify of Organization.Creates a new instance in shopify of this model.

v1-Organizations-{id}-stripe-count

Counts stripe of Organization.

v1-Organizations-{id}-stripe

Queries stripe of Organization.Creates a new instance in stripe of this model.

v1-Organizations-{id}-ticketingHub-count

Counts ticketingHub of Organization.

v1-Organizations-{id}-ticketingHub

Queries ticketingHub of Organization.Creates a new instance in ticketingHub of this model.

v1-Organizations-{id}-recurrences-count

Counts recurrences of Organization.

v1-Organizations-{id}-recurrences

Queries recurrences of Organization.

v1-Organizations-{id}-payments-count

Counts payments of Organization.

v1-Organizations-{id}-payments

Queries payments of Organization.Creates a new instance in payments of this model.

v1-Organizations-{id}-businessPremises

Queries businessPremises of Organization.Creates a new instance in businessPremises of this model.

v1-Organizations-{id}-electronicDevices

Queries electronicDevices of Organization.Creates a new instance in electronicDevices of this model.

v1-Organizations-{id}-accountOrganizations-count

Counts accountOrganizations of Organization.

v1-Organizations-{id}-accountOrganizations

Queries accountOrganizations of Organization.

v1-Organizations-{id}-units-count

Counts units of Organization.

v1-Organizations-{id}-units

Queries units of Organization.Creates a new instance in units of this model.

v1-Organizations-{id}-categories-count

Counts categories of Organization.

v1-Organizations-{id}-categories

Queries categories of Organization.Creates a new instance in categories of this model.

v1-Organizations-{id}-documentCategories-count

Counts documentCategories of Organization.

v1-Organizations-{id}-documentCategories

Queries documentCategories of Organization.

v1-Organizations-{id}-priceLists-count

Counts priceLists of Organization.

v1-Organizations-{id}-priceLists

Queries priceLists of Organization.Creates a new instance in priceLists of this model.

v1-Organizations-{id}-warehouses-count

Counts warehouses of Organization.

v1-Organizations-{id}-warehouses

Queries warehouses of Organization.Creates a new instance in warehouses of this model.

v1-Organizations-{id}-webhooks-count

Counts webhooks of Organization.

v1-Organizations-{id}-webhooks

Queries webhooks of Organization.Creates a new instance in webhooks of this model.

v1-Organizations-{id}-orders-count

Counts orders of Organization.

v1-Organizations-{id}-orders

Queries orders of Organization.

v1-Organizations-{id}-magento1-count

Counts magento1 of Organization.

v1-Organizations-{id}-magento1

Queries magento1 of Organization.Creates a new instance in magento1 of this model.

v1-Organizations-{id}-woocommerce-count

Counts woocommerce of Organization.

v1-Organizations-{id}-woocommerce

Queries woocommerce of Organization.Creates a new instance in woocommerce of this model.

v1-Organizations-{id}-customIntegrations-count

Counts customIntegrations of Organization.

v1-Organizations-{id}-customIntegrations

Queries customIntegrations of Organization.Creates a new instance in customIntegrations of this model.

v1-Organizations-{id}-thrivecart-count

Counts thrivecart of Organization.

v1-Organizations-{id}-thrivecart

Queries thrivecart of Organization.Creates a new instance in thrivecart of this model.

v1-Organizations-{id}-bokun-count

Counts bokun of Organization.

v1-Organizations-{id}-bokun

Queries bokun of Organization.Creates a new instance in bokun of this model.

v1-Organizations-{id}-shopamine-count

Counts shopamine of Organization.

v1-Organizations-{id}-shopamine

Queries shopamine of Organization.Creates a new instance in shopamine of this model.

v1-Organizations-{id}-activate

Organization.prototype.req Toggle Active post Organizations_{id} activate

v1-Organizations-{id}-deactivate

Organization.prototype.req Toggle Active post Organizations_{id} deactivate

v1-Organizations-{id}-is-unique-doc-number

Organization.prototype.is Unique Doc Number

v1-Organizations-{id}-last-doc-number

Organization.prototype.last Doc Number

v1-Organizations-{id}-next-doc-number

Organization.prototype.next Doc Number

v1-Organizations-{id}-subscription

Get currenct subscription

v1-Organizations-{id}-search-documents

DEPRECATED: Search documents endpoint

v1-Organizations-{id}-upload-image

Organization.prototype.upload Image post Organizations_{id} upload-image

v1-Organizations-{id}-images-logo

Organization.prototype.download Logo

v1-Organizations-{id}-images

Organization.prototype.upload Image post Organizations_{id} images Organization.prototype.delete Image delete Organizations_{id} images Organization.prototype.download Image get Organizations_{id} images

v1-Organizations-{id}-delete-image

Organization.prototype.delete Image delete Organizations_{id} delete-image

v1-Organizations-{id}-download-image

Organization.prototype.download Image get Organizations_{id} download-image

v1-Organizations-{id}-search-clients

Organization.prototype.search Clients get Organizations_{id} search-clients

v1-Organizations-{id}-search-items

Organization.prototype.search Items get Organizations_{id} search-items

v1-Organizations-{id}-business-stats

Provides business statistics about the given organization for a particular date range

v1-Organizations-{id}-total-stats

Provides financial statistics about the given organization

v1-Organizations-{id}-document-total-stats

Get organization's document stats

v1-Organizations-{id}-category-total-stats

Get organization's categories stats

v1-Organizations-{id}-payment-total-stats

Get organization's payments stats

v1-Organizations-{id}-this-month-invoices

Returns number of invoices issued by organization in this month

v1-Organizations-{id}-export

Organization.prototype.export

v1-Organizations-{id}-upload-certificate

Organization.prototype.upload Certificate

v1-Organizations-{id}-invite

Invite user to / give access to organization

v1-Organizations-{id}-has-certificate

Check if organization has certificate of a type

v1-Organizations-{id}-import

Import CSV data

v1-Organizations-{id}-reports-profit-and-loss

Generate category profit and loss report

v1-Organizations-{id}-reports-balance-sheet

Generate balance sheet balance sheet

v1-Organizations-{id}

Find a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Organizations-mailgun-route

Redirect mailgun to correct model

v1-Shopify-{id}-order

Shopify.prototype.process Order

v1-Shopify-{id}-import

Import integration data in excel format

v1-Shopify-{id}-orders-document

Shopify.prototype.find Order Document

v1-Shopify-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Shopify-incoming

Shopify.incoming

Shopify.application

v1-Stripe-{id}-incoming

Stripe.prototype.incoming

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-TicketingHub-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-TicketingHub-{id}

Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

Find all instances of the model matched by filter from the data source.

v1-Accounts-{id}-accessTokens-{fk}

Delete a related item by id for accessTokens.

v1-Accounts-{id}-accessTokens

Queries accessTokens of Account.Creates a new instance in accessTokens of this model.

v1-Accounts-{id}-usages-count

Counts usages of Account.

v1-Accounts-{id}-usages

Queries usages of Account.

v1-Accounts-{id}-organizations-count

Counts organizations of Account.

v1-Accounts-{id}-organizations

Queries organizations of Account.Creates a new instance in organizations of this model.

v1-Accounts-{id}-logs-count

Counts logs of Account.

v1-Accounts-{id}-logs

Queries logs of Account.

v1-Accounts-{id}-verify

Trigger user's identity verification with configured verifyOptions

v1-Accounts-{id}-is-verified

Check if account is verified.

v1-Accounts-{id}-send-verification

Request another verification email

v1-Accounts-{id}

Find a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Accounts-login

Login a user with username/email and password.

v1-Accounts-logout

Logout a user with access token.

v1-Accounts-confirm

Confirm a user registration with identity verification token.

v1-Accounts-reset

Reset password for a user with email.

v1-Accounts-change-password

Change a user's password.

v1-Accounts-reset-password

Reset user's password via a password-reset token.

v1-Accounts-is-unique

Check if e-mail already exists.

v1-Accounts-impersonate

Login as child account

v1-Accounts-authorized

Checks if user is authorized and returns user

v1-Accounts-identity-verification

Returns identity hash for user

v1-Accounts-subscription

Retrieve Account's active subscription

Create a new instance of the model and persist it into the data source.

v1-Recurrences-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Recurrences-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Recurrences-cron

Recurrence.run Cron

v1-Payments-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Payments-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-Defaults-{id}

Find a model instance by {{id}} from the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Companies-search

Find all instances of the model matched by filter from the data source.

v1-Subscriptions-{id}-whiteLabel

Creates a new instance in whiteLabel of this model.

v1-Subscriptions-{id}-payment-method

Get Payment method Add/Update payment method

v1-Subscriptions-client-token

Get Braintree client token

v1-Subscriptions-cron

Subscription.remote Cron

v1-Subscriptions

Find all instances of the model matched by filter from the data source.

Find all instances of the model matched by filter from the data source.

v1-WhiteLabels-{id}

Patch attributes for a model instance and persist it into the data source.

Create a new instance of the model and persist it into the data source.Find all instances of the model matched by filter from the data source.

v1-containers-{container}-download-{file}

container.download

v1-Messages-contact-sales

Message.remote Contact Sales

v1-BusinessPremises-{id}-electronicDevices

Creates a new instance in electronicDevices of this model.

v1-BusinessPremises-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-AtcudSeries-{id}-organization

Fetches belongsTo relation organization.

v1-AtcudSeries-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-AtcudSeries-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-AtcudSeries-findOne

Find first instance of the model matched by filter from the data source.

v1-AtcudSeries-count

Count instances of the model matched by where from the data source.

Create a new instance of the model and persist it into the data source.Find all instances of the model matched by filter from the data source.

Find all instances of the model matched by filter from the data source.

v1-tracking-webhook

Tracking.webhook

v1-ElectronicDevices-{id}

Patch attributes for a model instance and persist it into the data source.

v1-Certificates-expiry-cron

Certificate.remote Expiry Cron

v1-geoip-locate

Parse IP to geo location

v1-AccountOrganizations-{id}-accept

Confirm invitation to join organization

v1-AccountOrganizations-{id}-reject

Deny invitation to join organization

v1-AccountOrganizations-{id}-enable

Enable users access to organization

v1-AccountOrganizations-{id}-disable

Disable users access to organization

v1-AccountOrganizations-{id}-change-role

Account Organization.prototype.change Role

v1-AccountOrganizations-{id}

Delete a model instance by {{id}} from the data source.

v1-FileMeta-{id}

Delete a model instance by {{id}} from the data source.

v1-Units-{id}-last-doc-number

Unit.prototype.last Doc Number

v1-Units-{id}-next-doc-number

Unit.prototype.next Doc Number

v1-Units-{id}-upload-image

Unit.prototype.upload Image post Units_{id} upload-image

v1-Units-{id}-images

Unit.prototype.upload Image post Units_{id} images Unit.prototype.delete Image delete Units_{id} images Unit.prototype.download Image get Units_{id} images

v1-Units-{id}-delete-image

Unit.prototype.delete Image delete Units_{id} delete-image

v1-Units-{id}-download-image

Unit.prototype.download Image get Units_{id} download-image

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Categories-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Categories-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.

v1-DocumentCategories-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-DocumentCategories-{id}

Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-PriceLists-{id}-items-count

Counts items of PriceList.

v1-PriceLists-{id}-items

Queries items of PriceList.

v1-PriceLists-{id}-prices-count

Counts prices of PriceList.

v1-PriceLists-{id}-prices

Queries prices of PriceList.Creates a new instance in prices of this model.

v1-PriceLists-{id}

Find a model instance by {{id}} from the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Warehouses-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Warehouses-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Webhooks-{id}-replace

Replace attributes for a model instance and persist it into the data source.

v1-Webhooks-{id}

Find a model instance by {{id}} from the data source.Replace attributes for a model instance and persist it into the data source.Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Typless-webhook

Typless.remote On Webhook

v1-Orders-{id}-documents-create

Order.prototype.remote Create Document

Find a model instance by {{id}} from the data source.

v1-Magento1-{id}-order

Magento1.prototype.process Order

v1-Magento1-{id}-import

Import integration data in excel format

v1-Magento1-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Woocommerce-{id}-order

Woocommerce.prototype.process Order

v1-Woocommerce-{id}-import

Import integration data in excel format

v1-Woocommerce-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-CustomIntegrations-{id}-order

Custom Integration.prototype.process Order

v1-CustomIntegrations-{id}-import

Import integration data in excel format

v1-CustomIntegrations-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Thrivecart-{id}-order

Thrivecart.prototype.process Order Thrivecart.prototype.install

v1-Thrivecart-{id}-import

Import integration data in excel format

v1-Thrivecart-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Bokun-{id}-order

Bokun.prototype.process Order

v1-Bokun-{id}-import

Import integration data in excel format

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Shopamine-{id}-order

Shopamine.prototype.process Order

v1-Shopamine-{id}-import

Import integration data in excel format

v1-Shopamine-{id}

Delete a model instance by {{id}} from the data source.Patch attributes for a model instance and persist it into the data source.

v1-Sendgrid-webhook

Sendgrid.webhook

v1-Logs-cron-clear

v1-AWSSES-webhook

Health Controller.health

Home Space Invoices API v1-Subscriptions-{id}-payment-methodGet Payment method

Get Payment method

GET {{baseUrl}}/v1/Subscriptions/:id/payment-method

HEADERS

Key	Datatype	Required	Description
`Accept`	string

RESPONSES

status: OK

{}

v1-Subscriptions-{id}-payment-method

Add/Update payment method