Text2PayVersion: v3

Create & Send

POST/invoices/text2pay

API to create or update a text2pay invoice

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:invoices.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Body

application/json

altIdstringrequired

location Id / company Id based on altType

Example:6578278e879ad2646715ba9c

altTypestringrequired

Alt Type

Available optionslocation

Example:location

namestringrequired

Invoice Name

Example:New Invoice

currencystringrequired

Currency code

Example:USD

itemsobject[]required

An array of items for the invoice.

termsNotesstring

Terms notes, Also supports HTML markups

Example:<p>This is a default terms.</p>

titlestring

Title for the invoice

Example:INVOICE

contactDetailsobjectrequired

Contact information to send the invoice to

invoiceNumberstring

Invoice Number

Example:1001

issueDatestringrequired

Issue date in YYYY-MM-DD format

Example:2023-01-01

dueDatestring

Due date in YYYY-MM-DD format

Example:2023-01-14

sentToobjectrequired

liveModebooleanrequired

automaticTaxesEnabledboolean

Automatic taxes enabled for the Invoice

Example:true

paymentScheduleobject

split invoice into payment schedule summing up to full invoice amount

lateFeesConfigurationobject

late fees configuration

tipsConfigurationobject

tips configuration for the invoice

invoiceNumberPrefixstring

prefix for invoice number

Example:INV-

paymentMethodsobject

Payment Methods for Invoices

attachmentsobject[]

attachments for the invoice

miscellaneousChargesobject

miscellaneous charges for the invoice

idstring

id of invoice to update. If skipped, a new invoice will be created

includeTermsNoteboolean

include terms & notes with receipts

Example:true

actionstringrequired

create invoice in draft mode or send mode

Available optionsdraftsend

Example:draft

userIdstringrequired

id of user generating invoice

discountobject

businessDetailsobject

Response

application/json

Successful response

invoiceobjectrequired

invoiceUrlstringrequired

preview url of generated invoice