# List templates
GET https://api-sandbox.payabli.com/api/Query/templates/{orgId}
Retrieves a list of boarding templates for an organization. Use filters to limit results. You can't make a request that includes filters from the API console in the documentation. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
Reference: https://docs.payabli.com/developers/api-reference/templates/get-list-of-boarding-templates-for-organization
## OpenAPI Specification
```yaml
openapi: 3.1.1
info:
title: Get list of boarding templates for organization
version: endpoint_templates.ListTemplates
paths:
/Query/templates/{orgId}:
get:
operationId: list-templates
summary: Get list of boarding templates for organization
description: >-
Retrieves a list of boarding templates for an organization. Use filters
to limit results. You can't make a request that includes filters from
the API console in the documentation. The response won't be filtered.
Instead, copy the request, remove `parameters=` and run the request in a
different client.
tags:
- - subpackage_templates
parameters:
- name: orgId
in: path
description: The numeric identifier for organization, assigned by Payabli.
required: true
schema:
type: integer
- name: fromRecord
in: query
description: >-
The number of records to skip before starting to collect the result
set.
required: false
schema:
type: integer
default: 0
- name: limitRecord
in: query
description: >-
Max number of records to return for the query. Use `0` or negative
value to return all records.
required: false
schema:
type: integer
default: 20
- name: parameters
in: query
description: >-
Collection of field names, conditions, and values used to filter the
query.
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
For example:
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
should become:
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
See [Filters and Conditions
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
for help.
List of field names accepted:
- `createdAt` (gt, ge, lt, le, eq, ne)
- `title` (ct, nct)
- `description` (ct, nct)
- `code` (ct, nct)
- `orgParentname` (ct, nct)
List of comparison accepted - enclosed between parentheses:
- eq or empty => equal
- gt => greater than
- ge => greater or equal
- lt => less than
- le => less or equal
- ne => not equal
- ct => contains
- nct => not contains
- in => inside array
- nin => not inside array
List of parameters accepted:
- limitRecord : max number of records for query (default="20", "0"
or negative value for all)
- fromRecord : initial record in query
Example: title(ct)=hoa return all records with title containing
"hoa"
required: false
schema:
type: object
additionalProperties:
type: string
- name: sortBy
in: query
description: >-
The field name to use for sorting results. Use `desc(field_name)` to
sort descending by `field_name`, and use `asc(field_name)` to sort
ascending by `field_name`.
required: false
schema:
type: string
- name: requestToken
in: header
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/type_:TemplateQueryResponse'
components:
schemas:
type_:AcceptOauth:
type: boolean
type_:AcceptRegister:
type: boolean
type_:EntryAttributes:
type: string
type_:BoardingLinkId:
type: integer
type_:LastModified:
type: string
format: date-time
type_:OrgParentName:
type: string
type_:ReferenceName:
type: string
type_:ReferenceTemplateId:
type: integer
format: int64
type_:TemplateCode:
type: string
type_:TemplateName:
type: string
type_:BoardingQueryLinks:
type: object
properties:
acceptOauth:
$ref: '#/components/schemas/type_:AcceptOauth'
acceptRegister:
$ref: '#/components/schemas/type_:AcceptRegister'
entryAttributes:
$ref: '#/components/schemas/type_:EntryAttributes'
id:
$ref: '#/components/schemas/type_:BoardingLinkId'
lastUpdated:
$ref: '#/components/schemas/type_:LastModified'
orgParentName:
$ref: '#/components/schemas/type_:OrgParentName'
referenceName:
$ref: '#/components/schemas/type_:ReferenceName'
referenceTemplateId:
$ref: '#/components/schemas/type_:ReferenceTemplateId'
templateCode:
$ref: '#/components/schemas/type_:TemplateCode'
templateName:
$ref: '#/components/schemas/type_:TemplateName'
type_:CreatedAt:
type: string
format: date-time
type_:IsRoot:
type: boolean
type_:RecipientEmailNotification:
type: boolean
type_:Resumable:
type: boolean
type_:PosCol:
type: integer
type_:PosRow:
type: integer
type_:ReadOnly:
type: boolean
type_:ValueTemplates:
type: string
type_:Visible:
type: boolean
type_:TemplateElement:
type: object
properties:
posCol:
$ref: '#/components/schemas/type_:PosCol'
posRow:
$ref: '#/components/schemas/type_:PosRow'
readOnly:
$ref: '#/components/schemas/type_:ReadOnly'
value:
$ref: '#/components/schemas/type_:ValueTemplates'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:RequiredElement:
type: boolean
type_:TemplateAdditionalDataField:
type: object
properties:
visible:
$ref: '#/components/schemas/type_:Visible'
readOnly:
$ref: '#/components/schemas/type_:ReadOnly'
required:
$ref: '#/components/schemas/type_:RequiredElement'
posRow:
$ref: '#/components/schemas/type_:PosRow'
posCol:
$ref: '#/components/schemas/type_:PosCol'
value:
$ref: '#/components/schemas/type_:ValueTemplates'
label:
type: string
type:
type: string
type_:TemplateAdditionalDataSection:
type: object
properties:
visible:
$ref: '#/components/schemas/type_:Visible'
fields:
type: object
additionalProperties:
$ref: '#/components/schemas/type_:TemplateAdditionalDataField'
required:
- visible
- fields
type_:BusinessSection:
type: object
properties:
baddress:
$ref: '#/components/schemas/type_:TemplateElement'
baddress1:
$ref: '#/components/schemas/type_:TemplateElement'
bcity:
$ref: '#/components/schemas/type_:TemplateElement'
bcountry:
$ref: '#/components/schemas/type_:TemplateElement'
bstate:
$ref: '#/components/schemas/type_:TemplateElement'
btype:
$ref: '#/components/schemas/type_:TemplateElement'
bzip:
$ref: '#/components/schemas/type_:TemplateElement'
dbaname:
$ref: '#/components/schemas/type_:TemplateElement'
ein:
$ref: '#/components/schemas/type_:TemplateElement'
faxnumber:
$ref: '#/components/schemas/type_:TemplateElement'
legalname:
$ref: '#/components/schemas/type_:TemplateElement'
license:
$ref: '#/components/schemas/type_:TemplateElement'
licstate:
$ref: '#/components/schemas/type_:TemplateElement'
maddress:
$ref: '#/components/schemas/type_:TemplateElement'
maddress1:
$ref: '#/components/schemas/type_:TemplateElement'
mcity:
$ref: '#/components/schemas/type_:TemplateElement'
mcountry:
$ref: '#/components/schemas/type_:TemplateElement'
mstate:
$ref: '#/components/schemas/type_:TemplateElement'
mzip:
$ref: '#/components/schemas/type_:TemplateElement'
phonenumber:
$ref: '#/components/schemas/type_:TemplateElement'
startdate:
$ref: '#/components/schemas/type_:TemplateElement'
taxfillname:
$ref: '#/components/schemas/type_:TemplateElement'
visible:
$ref: '#/components/schemas/type_:Visible'
website:
$ref: '#/components/schemas/type_:TemplateElement'
additionalData:
$ref: '#/components/schemas/type_:TemplateAdditionalDataSection'
type_:SubFooter:
type: string
type_:SubHeader:
type: string
type_:BankSection:
type: object
properties:
visible:
$ref: '#/components/schemas/type_:Visible'
accountNumber:
$ref: '#/components/schemas/type_:TemplateElement'
accountType:
$ref: '#/components/schemas/type_:TemplateElement'
bankName:
$ref: '#/components/schemas/type_:TemplateElement'
routingNumber:
$ref: '#/components/schemas/type_:TemplateElement'
type_:DocumentSectionTermsAndConditionsTcLinksItem:
type: object
properties:
label:
type: string
value:
type: string
type_:DocumentSectionTermsAndConditions:
type: object
properties:
tcLinks:
type: array
items:
$ref: >-
#/components/schemas/type_:DocumentSectionTermsAndConditionsTcLinksItem
visible:
$ref: '#/components/schemas/type_:Visible'
type_:SignerSection:
type: object
properties:
visible:
$ref: '#/components/schemas/type_:Visible'
name:
$ref: '#/components/schemas/type_:TemplateElement'
ssn:
$ref: '#/components/schemas/type_:TemplateElement'
dob:
$ref: '#/components/schemas/type_:TemplateElement'
phone:
$ref: '#/components/schemas/type_:TemplateElement'
email:
$ref: '#/components/schemas/type_:TemplateElement'
address:
$ref: '#/components/schemas/type_:TemplateElement'
address1:
$ref: '#/components/schemas/type_:TemplateElement'
city:
$ref: '#/components/schemas/type_:TemplateElement'
country:
$ref: '#/components/schemas/type_:TemplateElement'
state:
$ref: '#/components/schemas/type_:TemplateElement'
zip:
$ref: '#/components/schemas/type_:TemplateElement'
acceptance:
$ref: '#/components/schemas/type_:TemplateElement'
signedDocumentReference:
$ref: '#/components/schemas/type_:TemplateElement'
additionalData:
$ref: '#/components/schemas/type_:TemplateAdditionalDataSection'
type_:DocumentSection:
type: object
properties:
visble:
$ref: '#/components/schemas/type_:Visible'
subFooter:
$ref: '#/components/schemas/type_:SubFooter'
subHeader:
$ref: '#/components/schemas/type_:SubHeader'
depositBank:
$ref: '#/components/schemas/type_:BankSection'
minimumDocuments:
type: integer
description: >-
The minimum number of documents the applicant must upload with the
application.
uploadDocuments:
type: boolean
description: >-
When `true`, allows the applicant to upload documents to the
application.
bankData:
$ref: '#/components/schemas/type_:BankSection'
termsAndConditions:
$ref: '#/components/schemas/type_:DocumentSectionTermsAndConditions'
signer:
$ref: '#/components/schemas/type_:SignerSection'
visible:
$ref: '#/components/schemas/type_:Visible'
withdrawalBank:
$ref: '#/components/schemas/type_:BankSection'
type_:OwnersSection:
type: object
properties:
contactEmail:
$ref: '#/components/schemas/type_:TemplateElement'
contactName:
$ref: '#/components/schemas/type_:TemplateElement'
contactPhone:
$ref: '#/components/schemas/type_:TemplateElement'
contactTitle:
$ref: '#/components/schemas/type_:TemplateElement'
multipleContacts:
type: boolean
description: Offer add more contacts
multipleOwners:
type: boolean
description: offer add more owners
oaddress:
$ref: '#/components/schemas/type_:TemplateElement'
ocity:
$ref: '#/components/schemas/type_:TemplateElement'
ocountry:
$ref: '#/components/schemas/type_:TemplateElement'
odriverstate:
$ref: '#/components/schemas/type_:TemplateElement'
ostate:
$ref: '#/components/schemas/type_:TemplateElement'
ownerdob:
$ref: '#/components/schemas/type_:TemplateElement'
ownerdriver:
$ref: '#/components/schemas/type_:TemplateElement'
owneremail:
$ref: '#/components/schemas/type_:TemplateElement'
ownername:
$ref: '#/components/schemas/type_:TemplateElement'
ownerpercent:
$ref: '#/components/schemas/type_:TemplateElement'
ownerphone1:
$ref: '#/components/schemas/type_:TemplateElement'
ownerphone2:
$ref: '#/components/schemas/type_:TemplateElement'
ownerssn:
$ref: '#/components/schemas/type_:TemplateElement'
ownertitle:
$ref: '#/components/schemas/type_:TemplateElement'
ozip:
$ref: '#/components/schemas/type_:TemplateElement'
subFooter:
$ref: '#/components/schemas/type_:SubFooter'
subHeader:
$ref: '#/components/schemas/type_:SubHeader'
visible:
$ref: '#/components/schemas/type_:Visible'
additionalData:
$ref: '#/components/schemas/type_:TemplateAdditionalDataSection'
type_:ProcessingSection:
type: object
properties:
avgmonthly:
$ref: '#/components/schemas/type_:TemplateElement'
binperson:
$ref: '#/components/schemas/type_:TemplateElement'
binphone:
$ref: '#/components/schemas/type_:TemplateElement'
binweb:
$ref: '#/components/schemas/type_:TemplateElement'
bsummary:
$ref: '#/components/schemas/type_:TemplateElement'
highticketamt:
$ref: '#/components/schemas/type_:TemplateElement'
mcc:
$ref: '#/components/schemas/type_:TemplateElement'
subFooter:
$ref: '#/components/schemas/type_:SubFooter'
subHeader:
$ref: '#/components/schemas/type_:SubHeader'
ticketamt:
$ref: '#/components/schemas/type_:TemplateElement'
visible:
$ref: '#/components/schemas/type_:Visible'
whenCharged:
$ref: '#/components/schemas/type_:TemplateElement'
whenDelivered:
$ref: '#/components/schemas/type_:TemplateElement'
whenProvided:
$ref: '#/components/schemas/type_:TemplateElement'
whenRefunded:
$ref: '#/components/schemas/type_:TemplateElement'
type_:SalesCode:
type: string
type_:SalesSection:
type: object
properties:
salesCode:
$ref: '#/components/schemas/type_:SalesCode'
salesCRM:
type: string
type_:TierItem:
type: object
properties:
amountxAuth:
type: number
format: double
highPayRange:
type: number
format: double
lowPayRange:
type: number
format: double
percentxAuth:
type: number
format: double
type_:AchTypesTiers:
type: object
properties:
ccd:
$ref: '#/components/schemas/type_:TierItem'
ppd:
$ref: '#/components/schemas/type_:TierItem'
web:
$ref: '#/components/schemas/type_:TierItem'
type_:AchAbsorbSection:
type: object
properties:
multiTier:
type: boolean
tiers:
type: array
items:
$ref: '#/components/schemas/type_:AchTypesTiers'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:BasicTemplateElement:
type: object
properties:
readOnly:
$ref: '#/components/schemas/type_:ReadOnly'
required:
$ref: '#/components/schemas/type_:RequiredElement'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:AchTypes:
type: object
properties:
ccd:
$ref: '#/components/schemas/type_:BasicTemplateElement'
ppd:
$ref: '#/components/schemas/type_:BasicTemplateElement'
web:
$ref: '#/components/schemas/type_:BasicTemplateElement'
type_:AchAcceptanceElement:
type: object
properties:
types:
$ref: '#/components/schemas/type_:AchTypes'
posCol:
$ref: '#/components/schemas/type_:PosCol'
posRow:
$ref: '#/components/schemas/type_:PosRow'
readOnly:
$ref: '#/components/schemas/type_:ReadOnly'
value:
$ref: '#/components/schemas/type_:ValueTemplates'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:AchFeeSection:
type: object
properties:
advancedSettlementAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
annualAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
chargebackAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
earlyTerminationAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
monthlyAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
quarterlyPCIAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
returnedAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
sameDayAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
sundayOriginationAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
verifyBankAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
verifyFundAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
verifyNegativeAchFee:
$ref: '#/components/schemas/type_:TemplateElement'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:TierItemPass:
type: object
properties:
amountFeeone-time:
type: number
format: double
amountFeeRecurring:
type: number
format: double
highPayRange:
type: number
format: double
lowPayRange:
type: number
format: double
percentFeeone-time:
type: number
format: double
percentFeeRecurring:
type: number
format: double
type_:AchTypesPass:
type: object
properties:
ccd:
$ref: '#/components/schemas/type_:TierItemPass'
ppd:
$ref: '#/components/schemas/type_:TierItemPass'
web:
$ref: '#/components/schemas/type_:TierItemPass'
type_:AchPassThroughSection:
type: object
properties:
multiTier:
type: boolean
tiers:
type: array
items:
$ref: '#/components/schemas/type_:AchTypesPass'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:AchService:
type: object
properties:
achAbsorb:
$ref: '#/components/schemas/type_:AchAbsorbSection'
achAbsorb_highPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
achAbsorb_lowPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
achAcceptance:
$ref: '#/components/schemas/type_:AchAcceptanceElement'
achFees:
$ref: '#/components/schemas/type_:AchFeeSection'
achPass_highPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
achPass_lowPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
achPassThrough:
$ref: '#/components/schemas/type_:AchPassThroughSection'
batchCutoffTime:
$ref: '#/components/schemas/type_:TemplateElement'
description: >-
Controls how to present the `batchCutoffTime` field on the
application. If this field isn't sent, batch cut off time defaults
to 5 ET.
discountFrequency:
$ref: '#/components/schemas/type_:TemplateElement'
fundingRollup:
$ref: '#/components/schemas/type_:TemplateElement'
gateway:
$ref: '#/components/schemas/type_:TemplateElement'
pdfTemplateId:
$ref: '#/components/schemas/type_:TemplateElement'
pricingPlan:
type: integer
format: int64
pricingType:
$ref: '#/components/schemas/type_:TemplateElement'
processor:
$ref: '#/components/schemas/type_:TemplateElement'
provider:
$ref: '#/components/schemas/type_:TemplateElement'
tierName:
$ref: '#/components/schemas/type_:TemplateElement'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:CardTypes:
type: object
properties:
amex:
$ref: '#/components/schemas/type_:BasicTemplateElement'
discover:
$ref: '#/components/schemas/type_:BasicTemplateElement'
masterCard:
$ref: '#/components/schemas/type_:BasicTemplateElement'
visa:
$ref: '#/components/schemas/type_:BasicTemplateElement'
type_:CardAcceptanceElement:
type: object
properties:
types:
$ref: '#/components/schemas/type_:CardTypes'
posCol:
$ref: '#/components/schemas/type_:PosCol'
posRow:
$ref: '#/components/schemas/type_:PosRow'
readOnly:
$ref: '#/components/schemas/type_:ReadOnly'
value:
type: string
visible:
$ref: '#/components/schemas/type_:Visible'
type_:CardFeeSection:
type: object
properties:
achBatchCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
annualCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
avsCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
chargebackCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
ddaRejectsCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
earlyTerminationCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
minimumProcessingCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
monthlyPCICardFee:
$ref: '#/components/schemas/type_:TemplateElement'
montlyPlatformCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
retrievalCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
transactionCardFee:
$ref: '#/components/schemas/type_:TemplateElement'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:CardType:
type: object
properties:
amex:
$ref: '#/components/schemas/type_:TierItem'
discover:
$ref: '#/components/schemas/type_:TierItem'
masterCard:
$ref: '#/components/schemas/type_:TierItem'
visa:
$ref: '#/components/schemas/type_:TierItem'
type_:CardFlatSection:
type: object
properties:
tiers:
type: array
items:
$ref: '#/components/schemas/type_:CardType'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:CardIcpSection:
type: object
properties:
tiers:
type: array
items:
$ref: '#/components/schemas/type_:CardType'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:CardTypePass:
type: object
properties:
amex:
$ref: '#/components/schemas/type_:TierItemPass'
discover:
$ref: '#/components/schemas/type_:TierItemPass'
masterCard:
$ref: '#/components/schemas/type_:TierItemPass'
visa:
$ref: '#/components/schemas/type_:TierItemPass'
type_:CardPassThroughSection:
type: object
properties:
multiTier:
type: boolean
tiers:
type: array
items:
$ref: '#/components/schemas/type_:CardTypePass'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:CardService:
type: object
properties:
batchCutoffTime:
$ref: '#/components/schemas/type_:TemplateElement'
description: >-
Controls how to present the `batchCutoffTime` field on the
application. If this field isn't sent, batch cut off time defaults
to 5 ET.
cardAcceptance:
$ref: '#/components/schemas/type_:CardAcceptanceElement'
cardFees:
$ref: '#/components/schemas/type_:CardFeeSection'
cardFlat:
$ref: '#/components/schemas/type_:CardFlatSection'
cardFlat_amountxAuth:
$ref: '#/components/schemas/type_:TemplateElement'
cardFlat_highPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
cardFlat_lowPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
cardFlat_percentxAuth:
$ref: '#/components/schemas/type_:TemplateElement'
cardICP:
$ref: '#/components/schemas/type_:CardIcpSection'
cardICP_amountxAuth:
$ref: '#/components/schemas/type_:TemplateElement'
cardICP_highPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
cardICP_lowPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
cardICP_percentxAuth:
$ref: '#/components/schemas/type_:TemplateElement'
cardPassThrough:
$ref: '#/components/schemas/type_:CardPassThroughSection'
cardPassThrough_amountRecurring:
$ref: '#/components/schemas/type_:TemplateElement'
cardPassThrough_amountxAuth:
$ref: '#/components/schemas/type_:TemplateElement'
cardPassThrough_highPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
cardPassThrough_lowPayRange:
$ref: '#/components/schemas/type_:TemplateElement'
cardPassThrough_percentRecurring:
$ref: '#/components/schemas/type_:TemplateElement'
cardPassThrough_percentxAuth:
$ref: '#/components/schemas/type_:TemplateElement'
discountFrequency:
$ref: '#/components/schemas/type_:TemplateElement'
fundingRollup:
$ref: '#/components/schemas/type_:TemplateElement'
gateway:
$ref: '#/components/schemas/type_:TemplateElement'
passThroughCost:
$ref: '#/components/schemas/type_:TemplateElement'
pdfTemplateId:
$ref: '#/components/schemas/type_:TemplateElement'
pricingPlan:
type: integer
format: int64
pricingType:
$ref: '#/components/schemas/type_:TemplateElement'
processor:
$ref: '#/components/schemas/type_:TemplateElement'
provider:
$ref: '#/components/schemas/type_:TemplateElement'
tierName:
$ref: '#/components/schemas/type_:TemplateElement'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:ServicesSection:
type: object
properties:
ach:
$ref: '#/components/schemas/type_:AchService'
card:
$ref: '#/components/schemas/type_:CardService'
subFooter:
$ref: '#/components/schemas/type_:SubFooter'
subHeader:
$ref: '#/components/schemas/type_:SubHeader'
visible:
$ref: '#/components/schemas/type_:Visible'
type_:UnderWritingMethod:
type: string
enum:
- value: automatic
- value: manual
- value: bypass
type_:PolicyId:
type: string
type_:UnderwritingDataResponse:
type: object
properties:
method:
$ref: '#/components/schemas/type_:UnderWritingMethod'
policyId:
$ref: '#/components/schemas/type_:PolicyId'
type_:TemplateContentResponse:
type: object
properties:
businessData:
$ref: '#/components/schemas/type_:BusinessSection'
documentsData:
$ref: '#/components/schemas/type_:DocumentSection'
ownershipData:
$ref: '#/components/schemas/type_:OwnersSection'
processingData:
$ref: '#/components/schemas/type_:ProcessingSection'
salesData:
$ref: '#/components/schemas/type_:SalesSection'
servicesData:
$ref: '#/components/schemas/type_:ServicesSection'
underwritingData:
$ref: '#/components/schemas/type_:UnderwritingDataResponse'
type_:TemplateQueryRecord:
type: object
properties:
addPrice:
type: boolean
boardingLinks:
type: array
items:
$ref: '#/components/schemas/type_:BoardingQueryLinks'
createdAt:
$ref: '#/components/schemas/type_:CreatedAt'
idTemplate:
type: integer
format: int64
isRoot:
$ref: '#/components/schemas/type_:IsRoot'
orgParentName:
$ref: '#/components/schemas/type_:OrgParentName'
recipientEmailNotification:
$ref: '#/components/schemas/type_:RecipientEmailNotification'
resumable:
$ref: '#/components/schemas/type_:Resumable'
templateCode:
$ref: '#/components/schemas/type_:TemplateCode'
templateContent:
$ref: '#/components/schemas/type_:TemplateContentResponse'
templateDescription:
type: string
templateTitle:
type: string
usedBy:
type: integer
type_:PageIdentifier:
type: string
type_:Pagesize:
type: integer
type_:Totalrecords:
type: integer
type_:QuerySummary:
type: object
properties:
pageIdentifier:
$ref: '#/components/schemas/type_:PageIdentifier'
pageSize:
$ref: '#/components/schemas/type_:Pagesize'
totalAmount:
type: number
format: double
description: Total amount for the records.
totalNetAmount:
type: number
format: double
description: Total net amount for the records.
totalPages:
$ref: '#/components/schemas/type_:Totalrecords'
totalRecords:
$ref: '#/components/schemas/type_:Totalrecords'
type_:TemplateQueryResponse:
type: object
properties:
records:
type: array
items:
$ref: '#/components/schemas/type_:TemplateQueryRecord'
summary:
$ref: '#/components/schemas/type_:QuerySummary'
```
## SDK Code Examples
```python
from payabli import payabli
client = payabli(
api_key="YOUR_API_KEY",
)
client.templates.list_templates(
org_id=123,
from_record=251,
limit_record=0,
sort_by="desc(field_name)",
)
```
```typescript
import { PayabliClient } from "@payabli/sdk-node";
const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.templates.listTemplates(123, {
fromRecord: 251,
limitRecord: 0,
sortBy: "desc(field_name)"
});
```
```go
import (
context "context"
option "github.com/payabli/sdk-go/option"
sdkgo "github.com/payabli/sdk-go"
sdkgoclient "github.com/payabli/sdk-go/client"
)
client := sdkgoclient.NewClient(
option.WithApiKey(
"",
),
)
response, err := client.Templates.ListTemplates(
context.TODO(),
123,
&sdkgo.ListTemplatesRequest{
FromRecord: sdkgo.Int(
251,
),
LimitRecord: sdkgo.Int(
0,
),
SortBy: sdkgo.String(
"desc(field_name)",
),
},
)
```
```csharp
using PayabliApi;
var client = new PayabliApiClient("API_KEY");
await client.Templates.ListTemplatesAsync(
123,
new ListTemplatesRequest
{
FromRecord = 251,
LimitRecord = 0,
SortBy = "desc(field_name)",
}
);
```
```ruby
require 'uri'
require 'net/http'
url = URI("https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["requestToken"] = ''
response = http.request(request)
puts response.read_body
```
```java
HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")
.header("requestToken", "")
.asString();
```
```php
request('GET', 'https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [
'headers' => [
'requestToken' => '',
],
]);
echo $response->getBody();
```
```swift
import Foundation
let headers = ["requestToken": ""]
let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/templates/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
```