Getting started

Welcome Getting help About

OpenAPI 3.0. Postman

Guides Overview

Create an Account Create an Organization Create and Send an Invoice Conclusion

Onboard a merchant Create and Send an Invoice

Enable Payment Processing Onboard an Organization Pay now button Create a Payment Intent Create a recurring charge

Enable Stripe Connect Onboard an Organization Pay now button

Enable Stripe Connect Onboard an Organization Generate an onboarding link Pay now button

Prerequisites Upload a Certificate Add a Business Premise Add an Electronic Device Go Live

Concepts Data Hierarchy Implementation Flow Authentication

Filters Where operators

Pagination

Introduction Supported locales Localizing user content Localizing Document content Localizing Item content Localizing defaults Localizing non-user content

Smart codes Model custom data

Introduction Decimal places Rounding

Replayable requests Rate limits Soft delete Errors Core Resources

Introduction The AccessToken Object Create AccessToken Find AccessTokens Delete AccessToken

Introduction The Account Object Create Account Get Account Patch Account Login Account Logout Account Login as / Impersonate Child Account Find Child Accounts Count Child Accounts Check if Account Authorized Check if Email is unique Verify Account Confirm Account Change Account password Request Account password reset Reset Account password Check if Account verified Request Account verification

Introduction The Category Object Create Category Get Category Find Categories Count Categories Replace Category Delete Category

Introduction The DocumentCategory Object Create DocumentCategory Find DocumentCategories Count DocumentCategories Replace DocumentCategory Patch DocumentCategory Delete DocumentCategory

Introduction The Client Object Create Client Get Client Find Clients Count Clients Search Clients Replace Client Patch Client Delete Client Send overdue reminder to Client

Introduction The Default Object Create Default Get Default Find Defaults Count Defaults Replace Default Patch Default Delete Default

Introduction The Document Object Create Document Get Document Find Documents Count Documents Replace Document Patch Document Delete Document Send a Document Download PDF Cancel Document Uncancel Document Fiscally verify Document Mark Document as sent Upload Attachment Download Document XML in E-slog format Parse to XML Share Document Get Document using shareableId Download XML in E-slog format using shareableId Download PDF using shareableId Download Attachment using shareableId Check is unique Document number Get last Document number Get next Document number Parse image to Document Create Comment Replace Comment Delete Comment

Introduction The EmailAddress Object Create EmailAddress on Account Get Account EmailAddresses Delete Account EmailAddress Get Account EmailAddress status Resend Account EmailAddress verification Create EmailAddress on Organization Get Organization EmailAddresses Delete Organization EmailAddress Get Organization EmailAddress status Resend Organization EmailAddress verification

Introduction The Item Object Create Item Get Item Find Items Count Items Search Items Replace Item Delete Item Find Item Inventories

Introduction The Organization Object Create Organization Get Organization Find Organizations Count Organizations Patch Organization Activate Organization Deactivate Organization Get Organization Subscription Upload Image for Organization Get Image for Organization Delete Image for Organization Download Image for Organization Download Organization Logo Export Organization Data Import Data for Organization Invite to Organization Get Organization Business Stats Get Organization Grouped Stats Get Organization Payment Stats Get Organization Category Stats Get Organization Document Stats Get Organization Profit-and-Loss report Get Organization Balance Sheet report Delete AccountOrganization Accept AccountOrganization Reject AccountOrganization Enable AccountOrganization Disable AccountOrganization Change AccountOrganization Role Find AccountOrganizations Count AccountOrganizations

Introduction The Payment Object Create Payment Get Payment Find Payments Count Payments Replace Payment Delete Payment Create Payment for Document Get Document's Payments Count Document's Payments

Introduction The PriceList Object Create PriceList Get PriceList Find PriceLists Count PriceLists Patch PriceList Delete PriceList Create Price for PriceList Find PricerList's Prices Count PriceList's Prices Patch Price Delete Price

Introduction The Recurrence Object Create Recurrence for Document Get Recurrence Find Recurrences Count Recurrences Replace Recurrence Delete Recurrence Get Document's Recurrence

Introduction The Tax Object Create Tax Get Tax Find Taxes Count Taxes Replace Tax Delete Tax Create TaxRate for Tax Delete Tax TaxRate Get Tax Clause

Introduction The Unit Object Create Unit Find Units Count Units Patch Unit Delete Unit Get last Document number for Unit Get next Document number for Unit Upload image for Unit Download Unit's image Delete Unit's image

Introduction The Warehouse Object Create Warehouse Get Warehouse Find Warehouses Count Warehouses Replace Warehouse Patch Warehouse Delete Warehouse

Payment Processing

Introduction The StripeConnect Object Create StripeConnect Get StripeConnect Patch StripeConnect Create StripeConnectAccount Get StripeConnectAccount Patch StripeConnectAccount Get StripeConnectAccount On-boarding Link Get Document's PaymentIntent

Other resources

Introduction The Country Object Find Countries

Introduction The Currency Object Find Currencies

Introduction The Webhook Object Create Webhook Get Webhook Find Webhooks Count Webhooks Replace Webhook Patch Webhook Delete Webhook

Introduction The WhiteLabel Object Find WhiteLabels Patch WhiteLabel

Connectors

Introduction The Bokun Object Create Bokun Find Bokuns Count Bokuns Patch Bokun Delete Bokun Import Bokun COD payments

Introduction The CustomIntegration Object Create CustomIntegration Find CustomIntegrations Count CustomIntegrations Patch CustomIntegration Delete CustomIntegration Import CustomIntegration COD payments

Introduction The Magento1 Object Create Magento1 Find Magento1s Count Magento1s Patch Magento1 Delete Magento1 Import Magento1 COD payments

Introduction The Order Object Get Order Find Orders Count Orders Create Document for Order

Introduction The Shopamine Object Create Shopamine Find Shopamines Count Shopamines Patch Shopamine Delete Shopamine Import Shopamine COD payments

Introduction The Shopify Object Create Shopify Find Shopifys Count Shopifys Patch Shopify Delete Shopify Import Shopify COD payments Create Document for Shopify order Get Shopify

Introduction The Stripe Object Create Stripe Find Stripes Count Stripes Patch Stripe Delete Stripe

Introduction The Thrivecart Object Create Thrivecart Find Thrivecarts Count Thrivecarts Patch Thrivecart Delete Thrivecart Import Thrivecart COD payments

Introduction The TicketingHub Object Create TicketingHub Find TicketingHubs Count TicketingHubs Replace TicketingHub Delete TicketingHub

Introduction The Woocommerce Object Create Woocommerce Find Woocommerces Count Woocommerces Patch Woocommerce Delete Woocommerce Import Woocommerce COD payments

Real-time reporting

Introduction The Fina Object Upload Certificate Check has Certificate

Introduction The Furs Object Upload Certificate Check has Certificate

Introduction The BusinessPremise Object Create BusinessPremises Find BusinessPremises Delete BusinessPremise Patch BusinessPremise Find BusinessPremise's ElectronicDevices

Introduction The ElectronicDevice Object Create ElectronicDevice Find ElectronicDevices Patch ElectronicDevice

UI Invoicing App UI SDK Changelog Changelog

Model custom data

Many models support adding free-form custom data through the custom property, which is of type object.

The custom property and its nested data can also be filtered when querying a model endpoint, for example:

?filter[where][custom.myProperty]=myValue

For more information on filtering, refer to the Filters section.

Here's an example of the custom property and its possible data types:

NOTE: Object properties can have deeper nesting.

Example custom data

    
      {
  "custom": {
    "string": "String",
    "boolean": true,
    "object": {
      "nested": "value"
    },
    "number": 42
  }
}

Model custom data

Next: Calculations >