Requirements
Connecting Anny Admin API takes an active account plus an API access token from your account settings — no other setup is required.[3]
Get your Anny Admin API credentials
anny - Primary
anny - Secondary
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- anny - Environmentselect
Select the environment.
[1] - Client IDtextRequired
A custom OAuth2 Client ID is a special case. Contact
[1][email protected]with your use case to request one. - Client SecretpasswordRequired
A custom OAuth2 Client ID is a special case. Contact
[1][email protected]with your use case to request one.
Connect Anny Admin API in WEXTL
- Log in to your WEXTL account, add the Anny Admin API node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Anny Admin API account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Anny Admin API node modules
The list below is a reference of every Anny Admin API node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Anny Admin API node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch BookingsTrigger
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Number | text |
| Status | text |
| Is blocker | boolean |
| Start date | date |
| End date | date |
| Blocker start date | date |
| Blocker end date | date |
| Description | text |
| Charged duration | number |
| Weight | number |
| Links | object |
| Self | text |
| Meta | array |
Watch Broadcast CampaignsTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Scheduled at | text |
| Status | text |
| Total count | number |
| Failed count | number |
| Sent count | number |
| Recurring | boolean |
| Cron | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Template | object |
| Audience | object |
Watch BusinessesTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Brand name | text |
| Domain | text |
| Billing email | |
| Vat ID | text |
| Notes | text |
| Custom entry map | object |
| Created at | date |
| Updated at | date |
| Meta | object |
| Has business account | boolean |
| Links | object |
| Self | text |
| Relationships | object |
| Billing address | object |
| Logo image | object |
| Customers | object |
| Custom entries | object |
| Customer balances | object |
| Payment setup | object |
Watch CalendarsTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Show description | boolean |
| Show customer | boolean |
| Show add ons | boolean |
| Show sub bookings | boolean |
| Show external events | boolean |
| Blocker style | text |
| Days before | number |
| Days after | number |
| Locale | text |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Meta | object |
| Calendar URL | text |
Watch Community InvitesTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| text | |
| Role | text |
| Body | text |
| Silent | boolean |
| Expiry | date |
| Accepted at | date |
| Start date | date |
| End date | date |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Community | object |
| Organization | object |
| User | object |
Watch Customer BalancesTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Total | number |
| Currency | text |
| Label | text |
| Status | text |
| Start date | date |
| End date | date |
| Issue at | date |
| Issued at | date |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Balanceable | object |
| Customer account | object |
| Invoices | object |
| Master invoice | object |
| Payment setup | object |
Watch CustomersTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| UUID | text |
| Number | text |
| Locale | text |
| Title | text |
| Given name | text |
| Family name | text |
| Full name | text |
| Sex | text |
| Birth date | date |
| Links | object |
| Self | text |
| Relationships | object |
| Address | object |
| Delivery address | object |
| Business | object |
| Custom entries | object |
| Orders | object |
| Model identifiers | object |
| Subscriptions | object |
| Communities | object |
| Community invites | object |
| Document acceptances | object |
| Meta | object |
| Has account | boolean |
| External ID | text |
| Idp user ID | text |
Watch InvoicesTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Formatted number | text |
| Currency | text |
| Is cancellation | boolean |
| Is credit | boolean |
| Has payment | boolean |
| Show transfer note | boolean |
| Vat number | text |
| Notes | text |
| Recipient | text |
| Links | object |
| Self | text |
| Relationships | object |
| Order | object |
| Items | object |
| Payments | object |
| Organization | object |
Watch OrdersTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
Watch ResourcesTrigger
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Description | text |
| Plain description | text |
| Availability mode | text |
| Continuous | boolean |
| Color | text |
| Auto accept bookings | boolean |
| Timezone | text |
| Quantity | number |
| Links | object |
| Self | text |
| Meta | object |
| Is available | text |
| Booking count | text |
| Number available | text |
| Minimal service | object |
| Service list | text |
| Services count | number |
| Settings | object |
| Meta settings | object |
| Zoom | boolean |
| Client URL | url |
Watch Schedule GroupsTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Available from | text |
| Available to | text |
| Timezone | text |
| Preview label | text |
| Default | boolean |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Schedules | object |
| Resources | object |
| Resource schedule groups | object |
| Meta | object |
| Resources count | number |
Watch ServicesTrigger
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | boolean |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | boolean |
| Allow cross schedule | boolean |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
Watch TestsTrigger
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Result options | array |
| Auto result | text |
| Auto result delay | number |
| Certificate body | text |
| Certificate footer | text |
| Issuing authority | text |
| Doctor name | text |
| Valid period | number |
| Test type options | array |
| Links | object |
| Self | text |
Watch Timeslot Resource AllocationsTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Status | text |
| Capacity multiplier | number |
| Order index | number |
| Imputed costs | text |
| Is externally blocked | boolean |
| Is required | boolean |
| Provisioned at | text |
| Provisioned by booking ID | text |
| Visible to customer | boolean |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslot | object |
Watch Timeslot SeriesTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Start date | date |
| End date | date |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslots | object |
Watch TimeslotsTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Title i 18n | object |
| Description | text |
| Descriptaion i 18n | object |
| Start date | date |
| End date | date |
| Timezone | text |
| Quota | text |
| Resource info | array |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Service | object |
| Series | object |
| Cover image | object |
| Resource allocations | object |
| Model syncs | object |
| Meta | object |
| Provisioned quota | number |
| Active booking count | number |
| Pending booking count | number |
| Total booking count | number |
| Available provisioned slots | number |
| Pending capacity | number |
| Protected | array |
Watch VouchersTrigger
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Code | text |
| Absolute discount | text |
| Currency | text |
| Relative discount | text |
| Number available | number |
| Expires at | date |
| Include add ons | boolean |
| Description | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Orders | object |
Get a BookingAction
Get a Booking Model IdentifierAction
Get a Broadcast CampaignAction
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Scheduled at | text |
| Status | text |
| Total count | number |
| Failed count | number |
| Sent count | number |
| Recurring | boolean |
| Cron | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Template | object |
| Audience | object |
Get a BusinessAction
| Field | Type |
|---|---|
Business IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Brand name | text |
| Domain | text |
| Billing email | |
| Vat ID | text |
| Notes | text |
| Custom entry map | object |
| Created at | date |
| Updated at | date |
| Meta | object |
| Has business account | boolean |
| Links | object |
| Self | text |
| Relationships | object |
| Billing address | object |
| Logo image | object |
| Customers | object |
| Custom entries | object |
| Customer balances | object |
| Payment setup | object |
Get a CommunityAction
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Color | text |
| Icon | text |
| Welcome text | text |
| Is private | boolean |
| Allow customer requests | boolean |
| Allow organization requests | boolean |
| Auto join enabled | boolean |
| Auto join settings | text |
| Links | object |
| Self | text |
| Relationships | object |
| Domains | object |
| Logo image | object |
| Resources | object |
| Resource groups | object |
| Services | object |
| Organizations | object |
| Owner organization | object |
| Community accounts | object |
| Unpersonalized invite | object |
| Booking quotas | object |
| Meta | object |
| Members count | number |
Get a CustomerAction
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| UUID | text |
| Number | text |
| Locale | text |
| Title | text |
| Given name | text |
| Family name | text |
| Full name | text |
| Sex | text |
| Birth date | date |
| Links | object |
| Self | text |
| Relationships | object |
| Address | object |
| Delivery address | object |
| Business | object |
| Custom entries | object |
| Orders | object |
| Model identifiers | object |
| Subscriptions | object |
| Communities | object |
| Community invites | object |
| Document acceptances | object |
| Meta | object |
| Has account | boolean |
| External ID | text |
| Idp user ID | text |
Get a Customer Balance DetailsAction
| Field | Type |
|---|---|
Customer Balance UUIDRequired | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | text |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | text |
| Allow cross schedule | text |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
Get a PropertyAction
Get a ResourceAction
| Field | Type |
|---|---|
Resource IDRequired | choice |
| Include | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Description | text |
| Plain description | text |
| Availability mode | text |
| Continuous | boolean |
| Color | text |
| Auto accept bookings | boolean |
| Timezone | text |
| Quantity | number |
| Links | object |
| Self | text |
| Meta | object |
| Is available | text |
| Booking count | text |
| Number available | text |
| Minimal service | object |
| Service list | text |
| Services count | number |
| Settings | object |
| Meta settings | object |
| Zoom | boolean |
| Client URL | url |
Get a Resource GroupAction
Get a ScheduleAction
Get a Schedule GroupAction
| Field | Type |
|---|---|
Schedule Group IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Available from | text |
| Available to | text |
| Timezone | text |
| Preview label | text |
| Default | boolean |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Schedules | object |
| Resources | object |
| Resource schedule groups | object |
| Meta | object |
| Resources count | number |
Get a ServiceAction
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | text |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | text |
| Allow cross schedule | text |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
Get a TestAction
| Field | Type |
|---|---|
Test IDRequired | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Result options | array |
| Auto result | text |
| Auto result delay | number |
| Certificate body | text |
| Certificate footer | text |
| Issuing authority | text |
| Doctor name | text |
| Valid period | number |
| Test type options | array |
| Links | object |
| Self | text |
Get a TimeslotAction
| Field | Type |
|---|---|
Timslot IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Title i 18n | object |
| Description | text |
| Description i 18n | object |
| Start date | date |
| End date | date |
| Timezone | text |
| Quota | text |
| Resource info | array |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Service | object |
| Series | object |
| Cover image | object |
| Resource allocations | object |
| Model syncs | object |
| Meta | object |
| Provisioned quota | number |
| Active booking count | number |
| Pending booking count | number |
| Total booking count | number |
| Available provisioned slots | number |
| Pending capacity | number |
| Protected | array |
Get a Timeslot Resource AllocationAction
| Field | Type |
|---|---|
Timeslot Resource Allocation IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Status | text |
| Capacity multiplier | number |
| Order index | number |
| Imputed costs | text |
| Is externally blocked | boolean |
| Is required | boolean |
| Provisioned at | text |
| Provisioned by booking ID | text |
| Visible to customer | boolean |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslot | object |
Get a Timeslot SeriesAction
Get a VoucherAction
| Field | Type |
|---|---|
Voucher IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Code | text |
| Absolute discount | text |
| Currency | text |
| Relative discount | text |
| Number available | number |
| Expires at | date |
| Include add ons | boolean |
| Description | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Orders | object |
Get an Add-onAction
Get an Add-on GroupAction
Get an ICS CalendarAction
| Field | Type |
|---|---|
ISC Calendar IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Show description | boolean |
| Show customer | boolean |
| Show add ons | boolean |
| Show sub bookings | boolean |
| Show external events | boolean |
| Blocker style | text |
| Days before | number |
| Days after | number |
| Locale | text |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Meta | object |
| Calendar URL | text |
Get an InvoiceAction
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Formatted number | text |
| Currency | text |
| Is cancellation | boolean |
| Is credit | boolean |
| Has payment | boolean |
| Show transfer note | boolean |
| Vat number | text |
| Notes | text |
| Recipient | text |
| Links | object |
| Self | text |
| Relationships | object |
| Order | object |
| Items | object |
| Payments | object |
| Organization | object |
Get an OrderAction
| Field | Type |
|---|---|
Order IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
Get OrganizationAction
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Official name | text |
| Description | text |
| Plain description | text |
| Support email | text |
| Phone | text |
| Currency | text |
| Timezone | text |
| Country code | text |
| Links | object |
| Self | text |
| Relationships | object |
| Industry | object |
| Addresses | object |
| Resources | object |
| Cover image | object |
| Logo image | object |
| Negative logo image | object |
| Organization users | object |
| Legal documents | object |
| Bank accounts | object |
| Resource groups | object |
Get UserAction
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Official name | text |
| Description | text |
| Plain description | text |
| Support email | text |
| Phone | text |
| Currency | text |
| Timezone | text |
| Country code | text |
| Links | object |
| Self | text |
| Relationships | object |
| Industry | object |
| Addresses | object |
| Resources | object |
| Cover image | object |
| Logo image | object |
| Negative logo image | object |
| Organization users | object |
| Legal documents | object |
| Bank accounts | object |
| Resource groups | object |
List Add-on GroupsSearch
List Add-onsSearch
List Booking Custom EntriesSearch
List Booking ScansSearch
List Booking Test ResultsSearch
List BookingsSearch
| Field | Type |
|---|---|
| Organization ID | choice |
| Filter Start Date Range | choice |
| Filter End Date Range | date |
| Filter Period Range | date |
| Filter Resources | choice |
| Filter Resource Groups | choice |
| Filter Services | choice |
| Filter Status | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Number | text |
| Status | text |
| Is blocker | boolean |
| Start date | date |
| End date | date |
| Blocker start date | date |
| Blocker end date | date |
| Description | text |
| Charged duration | number |
| Weight | number |
| Links | object |
| Self | text |
| Meta | array |
List Broadcast CampaignsSearch
| Field | Type |
|---|---|
| Filter Search | text |
| Sort | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Scheduled at | text |
| Status | text |
| Total count | number |
| Failed count | number |
| Sent count | number |
| Recurring | boolean |
| Cron | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Template | object |
| Audience | object |
List BusinessesSearch
| Field | Type |
|---|---|
| Sort | choice |
| Filter by UUIDs | choice |
| Exclude UUIDs | choice |
| Filter by Name | text |
| Full-text Search | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Brand name | text |
| Domain | text |
| Billing email | |
| Vat ID | text |
| Notes | text |
| Custom entry map | object |
| Created at | date |
| Updated at | date |
| Meta | object |
| Has business account | boolean |
| Links | object |
| Self | text |
| Relationships | object |
| Billing address | object |
| Logo image | object |
| Customers | object |
| Custom entries | object |
| Customer balances | object |
| Payment setup | object |
List CommunitiesSearch
| Field | Type |
|---|---|
| Filter by Name | text |
| Filter by Is Private | text |
| Filter by Search | text |
| Filter by IDs | choice |
| Sort | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Color | text |
| Icon | text |
| Welcome text | text |
| Is private | boolean |
| Allow customer requests | boolean |
| Allow organization requests | boolean |
| Auto join enabled | boolean |
| Auto join settings | text |
| Links | object |
| Self | text |
| Relationships | object |
| Domains | object |
| Logo image | object |
| Resources | object |
| Resource groups | object |
| Services | object |
| Organizations | object |
| Owner organization | object |
| Community accounts | object |
| Unpersonalized invite | object |
| Booking quotas | object |
| Meta | object |
| Members count | number |
List Community InvitesSearch
| Field | Type |
|---|---|
| Filter by Email | text |
| Filter by Accepted At | date |
| Filter by Expiry | date |
| Filter by Open | text |
| Sort | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| text | |
| Role | text |
| Body | text |
| Silent | boolean |
| Expiry | date |
| Accepted at | date |
| Start date | date |
| End date | date |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Community | object |
| Organization | object |
| User | object |
List Customer BalancesSearch
| Field | Type |
|---|---|
| Sort | choice |
| Filter Status | choice |
| Filter Balanceable Type | choice |
| Filter Balanceable ID | choice |
| Filter Currency | text |
| Filter Start Date From | date |
| Filter Start Date To | date |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Total | number |
| Currency | text |
| Label | text |
| Status | text |
| Start date | date |
| End date | date |
| Issue at | date |
| Issued at | date |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Balanceable | object |
| Customer account | object |
| Invoices | object |
| Master invoice | object |
| Payment setup | object |
List Customer BookingsSearch
| Field | Type |
|---|---|
| Customer ID | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | url |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
List Customer OrdersSearch
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
List CustomersSearch
| Field | Type |
|---|---|
| Sort | choice |
| Filter Search | text |
| Filter Email | |
| Filter Mobile | text |
| Filter Community | choice |
| Filter Custom Fields | object |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| UUID | text |
| Number | text |
| Locale | text |
| Title | text |
| Given name | text |
| Family name | text |
| Full name | text |
| Sex | text |
| Birth date | date |
| Links | object |
| Self | text |
| Relationships | object |
| Address | object |
| Delivery address | object |
| Business | object |
| Custom entries | object |
| Orders | object |
| Model identifiers | object |
| Subscriptions | object |
| Communities | object |
| Community invites | object |
| Document acceptances | object |
| Meta | object |
| Has account | boolean |
| External ID | text |
| Idp user ID | text |
List ICS CalendarsSearch
| Field | Type |
|---|---|
| Filter | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Show description | boolean |
| Show customer | boolean |
| Show add ons | boolean |
| Show sub bookings | boolean |
| Show external events | boolean |
| Blocker style | text |
| Days before | number |
| Days after | number |
| Locale | text |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Meta | object |
| Calendar URL | text |
List InvoicesSearch
| Field | Type |
|---|---|
| Sort | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Formatted number | text |
| Currency | text |
| Is cancellation | boolean |
| Is credit | boolean |
| Has payment | boolean |
| Show transfer note | boolean |
| Vat number | text |
| Notes | text |
| Recipient | text |
| Links | object |
| Self | text |
| Relationships | object |
| Order | object |
| Items | object |
| Payments | object |
| Organization | object |
List OrdersSearch
| Field | Type |
|---|---|
| Sort | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
List PropertiesSearch
List Resource GroupsSearch
List ResourcesSearch
| Field | Type |
|---|---|
| Filter Groups | choice |
| Filter Categories | choice |
| Sort | text |
| Limit | number |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Description | text |
| Plain description | text |
| Availability mode | text |
| Continuous | boolean |
| Color | text |
| Auto accept bookings | boolean |
| Timezone | text |
| Quantity | number |
| Links | object |
| Self | text |
| Meta | object |
| Is available | text |
| Booking count | text |
| Number available | text |
| Minimal service | object |
| Service list | text |
| Services count | number |
| Settings | object |
| Meta settings | object |
| Zoom | boolean |
| Client URL | url |
List Schedule GroupsSearch
| Field | Type |
|---|---|
| Filter with Resource Count | text |
| Filter Search | text |
| Sort | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Available from | text |
| Available to | text |
| Timezone | text |
| Preview label | text |
| Default | boolean |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Schedules | object |
| Resources | object |
| Resource schedule groups | object |
| Meta | object |
| Resources count | number |
List ServicesSearch
| Field | Type |
|---|---|
| Filter Is Rental Option | boolean |
| Sort | text |
| Limit | number |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | boolean |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | boolean |
| Allow cross schedule | boolean |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
List TestsSearch
List Timeslot Resource AllocationsSearch
| Field | Type |
|---|---|
| Filter by Status | text |
| Filter by External Block Status | text |
| Filter by Requirement Status | text |
| Sort | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Status | text |
| Capacity multiplier | number |
| Order index | number |
| Imputed costs | text |
| Is externally blocked | boolean |
| Is required | boolean |
| Provisioned at | text |
| Provisioned by booking ID | text |
| Visible to customer | boolean |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslot | object |
List Timeslot SeriesSearch
List TimeslotsSearch
| Field | Type |
|---|---|
| Sort | choice |
| Filter Start Date | date |
| Filter End Date | date |
| Filter Upcoming Only | boolean |
| Filter Past Only | boolean |
| Filter Resources | text |
| Filter Resources (Alias) | text |
| Filter Resource Groups | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Title i 18n | object |
| Description | text |
| Descriptaion i 18n | object |
| Start date | date |
| End date | date |
| Timezone | text |
| Quota | text |
| Resource info | array |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Service | object |
| Series | object |
| Cover image | object |
| Resource allocations | object |
| Model syncs | object |
| Meta | object |
| Provisioned quota | number |
| Active booking count | number |
| Pending booking count | number |
| Total booking count | number |
| Available provisioned slots | number |
| Pending capacity | number |
| Protected | array |
List VouchersSearch
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Code | text |
| Absolute discount | text |
| Currency | text |
| Relative discount | text |
| Number available | number |
| Expires at | date |
| Include add ons | boolean |
| Description | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Orders | object |
Cancel an InvoiceAction
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Cancel an OrderAction
| Field | Type |
|---|---|
Order IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
Change Invoice RecipientAction
| Field | Type |
|---|---|
Invoice IDRequired | choice |
RecipientRequired | text |
Check In BookingAction
Check Out BookingAction
Create a BusinessAction
| Field | Type |
|---|---|
TypeRequired | choice |
AttributesRequired | object |
NameRequired | text |
| Billing Email | |
| Brand Name | text |
| Domain | text |
| Notes | text |
| VAT ID | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Brand name | text |
| Domain | text |
| Billing email | |
| Vat ID | text |
| Notes | text |
| Custom entry map | object |
| Created at | date |
| Updated at | date |
| Meta | object |
| Has business account | boolean |
| Links | object |
| Self | text |
| Relationships | object |
| Billing address | object |
| Logo image | object |
| Customers | object |
| Custom entries | object |
| Customer balances | object |
| Payment setup | object |
Create a CustomerAction
| Field | Type |
|---|---|
| Attributes | object |
| Locale | text |
| Title | text |
| Sex | number |
| Birth Date | date |
| Given Name | text |
| Family Name | text |
| Mobile | text |
| Company | text |
| Custom Entry Map | object |
| Relationships | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| UUID | text |
| Number | text |
| Locale | text |
| Title | text |
| Given name | text |
| Family name | text |
| Full name | text |
| Sex | text |
| Birth date | date |
| Links | object |
| Self | text |
| Relationships | object |
| Address | object |
| Delivery address | object |
| Business | object |
| Custom entries | object |
| Orders | object |
| Model identifiers | object |
| Subscriptions | object |
| Communities | object |
| Community invites | object |
| Document acceptances | object |
| Meta | object |
| Has account | boolean |
| External ID | text |
| Idp user ID | text |
Create a PropertyAction
| Field | Type |
|---|---|
| Attributes | object |
| Filterable | text |
| Icon | text |
| Label | text |
| Private | text |
| Value Type | text |
| Meta | array |
| Relationships | object |
| Category | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Label | text |
| Icon | text |
| Value type | text |
| Filterable | boolean |
| Private | boolean |
| Links | object |
| Self | text |
| Relationships | object |
| Resource properties | object |
| Meta | object |
| Options | array |
Create a Recurring TimeslotsAction
| Field | Type |
|---|---|
Timslot IDRequired | choice |
| Count | number |
| Days | array |
| Day | number |
| Frequency | choice |
| Interval | number |
| Month Day | number |
| Until | date |
| Week Start | text |
Create a ResourceAction
| Field | Type |
|---|---|
| Attributes | object |
| Auto Accept Booking | text |
| Available From | text |
| Available To | text |
| Description | text |
| Has Children | text |
| Max Booking Quantity | text |
| Name | text |
| Quantity | text |
| Staggered Quantity | text |
| Relationships | object |
| Category | object |
| Group | object |
| Type | text |
| Meta | array |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Description | text |
| Plain description | text |
| Availability mode | text |
| Continuous | boolean |
| Color | text |
| Auto accept bookings | boolean |
| Timezone | text |
| Quantity | number |
| Links | object |
| Self | text |
| Meta | object |
| Is available | text |
| Booking count | text |
| Number available | text |
| Minimal service | object |
| Service list | text |
| Services count | number |
| Settings | object |
| Meta settings | object |
| Zoom | boolean |
| Client URL | url |
Create a Resource GroupAction
Create a ScheduleAction
| Field | Type |
|---|---|
| Attributes | object |
| Local End Time | time |
| Local Start Time | time |
| Quota | text |
| Weekday | number |
| Meta | array |
| Relationships | object |
| Organization ID | choice |
| Types | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Start time | text |
| Local start time | text |
| End time | text |
| Local end time | text |
| Timezone | text |
| Weekday | number |
| Quota | number |
| Links | object |
| Self | url |
Create a ServiceAction
| Field | Type |
|---|---|
| Attributes | object |
| Access Code | text |
| Advance Booking Period | text |
| Allow Customer Notes | text |
| Allow More Bookings | text |
| Booking Interval | text |
| Calculation Interval | text |
| Currency | text |
| Default Weight | text |
| Description | text |
| Has Flexible Duration | text |
| Type | text |
| Meta | array |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | text |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | text |
| Allow cross schedule | text |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
Create a TestAction
| Field | Type |
|---|---|
| Attributes | object |
| Name | text |
| Display Tester | boolean |
| Validate Download | boolean |
| Auto Result | text |
| Auto Result Delay | number |
| Certificate Body | text |
| Certificate Footer | text |
| Default Test Type | text |
| Doctor Name | text |
| Issuing Authority | text |
| Meta | object |
| Relationships | object |
| Custom Fields | object |
| Organization ID | choice |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Result options | array |
| Auto result | text |
| Auto result delay | number |
| Certificate body | text |
| Certificate footer | text |
| Issuing authority | text |
| Doctor name | text |
| Valid period | number |
| Test type options | array |
| Links | object |
| Self | text |
Create a TimeslotAction
| Field | Type |
|---|---|
| Organization ID | choice |
| Attributes | object |
| Base Quota | number |
| Cancellation Offset Type | text |
| Cancellation Offset Value | number |
| Description | text |
| Description I18N | object |
| Dynamic Capacity | boolean |
| End Date | date |
| Max Dynamic Quota | number |
| Min Bookings Count | number |
| Quota | number |
| Meta | array |
| Relationships | object |
| Resource | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Title i 18n | object |
| Description | text |
| Description i 18n | object |
| Start date | date |
| End date | date |
| Timezone | text |
| Quota | text |
| Resource info | array |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Service | object |
| Series | object |
| Cover image | object |
| Resource allocations | object |
| Model syncs | object |
| Meta | object |
| Provisioned quota | number |
| Active booking count | number |
| Pending booking count | number |
| Total booking count | number |
| Available provisioned slots | number |
| Pending capacity | number |
| Protected | array |
Create a Timeslot SeriesAction
| Field | Type |
|---|---|
AttributesRequired | object |
NameRequired | text |
| Local Name i18n | object |
| Relationships | object |
| Resource | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Start date | date |
| End date | date |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslots | object |
Create a VoucherAction
| Field | Type |
|---|---|
| Type | text |
| Attributes | object |
| Absolute Discount | number |
| Code | text |
| Currency | text |
| Expires At | date |
| Include Add Ons | boolean |
| Relative Discount | number |
| Meta | array |
| Relationships | object |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Code | text |
| Absolute discount | text |
| Currency | text |
| Relative discount | text |
| Number available | number |
| Expires at | date |
| Include add ons | boolean |
| Description | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Orders | object |
Create an Add-onAction
| Field | Type |
|---|---|
| Attributes | object |
| Currency | text |
| Customer Notice | text |
| Description | text |
| Is Net Price | boolean |
| Is Third Party | boolean |
| Lead Time | number |
| Name | text |
| Plain Description | text |
| Price | number |
| Tax Rate | number |
| Relationships | text |
| Organization ID | choice |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Description | text |
| Plain description | text |
| Customer notice | text |
| Lead time | number |
| Is third party | boolean |
| Is net price | boolean |
| Currency | text |
| Tax rate | number |
| Price | number |
| Links | object |
| Self | url |
Create an InvoiceAction
| Field | Type |
|---|---|
| Attributes | object |
| Access Token | text |
| Created At | text |
| Currency | text |
| Due Date | date |
| Formatted Number | text |
| Has Payment | boolean |
| Invoicing Party | text |
| Is Cancellation | boolean |
| Is Credit | boolean |
| Is Processing | boolean |
| Organization ID | choice |
Add to BalanceRequired | choice |
| Links | object |
| Self | url |
| Relationships | object |
| Items | object |
| Order | object |
| Organization | object |
| Payments | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Formatted number | text |
| Currency | text |
| Is cancellation | boolean |
| Is credit | boolean |
| Has payment | boolean |
| Show transfer note | boolean |
| Vat number | text |
| Notes | text |
| Recipient | text |
| Links | object |
| Self | text |
| Relationships | object |
| Order | object |
| Items | object |
| Payments | object |
| Organization | object |
Create an OrderAction
| Field | Type |
|---|---|
| Attributes | object |
CurrencyRequired | text |
StatusRequired | text |
| Relationships | object |
| Customer | object |
| Bookings | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
Create Booking Add-OnAction
| Field | Type |
|---|---|
| Attributes | object |
| Quantity | text |
| Total | text |
| Meta | array |
| Relationships | object |
| Add On | object |
| Booking | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Quantity | number |
| Total | number |
| Is net total | boolean |
| Single total | number |
| Charged single total | number |
| Charged total | number |
| Links | object |
| Self | text |
| Relationships | object |
| Add on | object |
| Booking | object |
Create Booking or BlockerAction
| Field | Type |
|---|---|
| Attributes | object |
| Blocker End Date | date |
| Blocker Start Date | date |
| Currency | text |
| Custom Entry Map | object |
| Description | text |
| End Date | date |
| Is Blocker | boolean |
| Is Net Total | boolean |
| Is Sub Booking | boolean |
| Manually Created | boolean |
| Meta | object |
| Relationships | object |
| Order | object |
| Resource | object |
| Service | object |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Number | text |
| Status | text |
| Is blocker | boolean |
| Start date | date |
| End date | date |
| Blocker start date | date |
| Blocker end date | date |
| Description | text |
| Charged duration | number |
| Weight | number |
| Links | object |
| Self | text |
| Meta | array |
Create ICS CalendarAction
| Field | Type |
|---|---|
| Attributes | object |
| Blocker Style | text |
| Days After | text |
| Days Before | text |
| Locale | text |
| Name | text |
| Show Add Ons | text |
| Show Customer | text |
| Show Description | text |
| Show External Events | text |
| Show Sub Bookings | text |
| Meta | array |
| Relationships | object |
| Resources | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Show description | boolean |
| Show customer | boolean |
| Show add ons | boolean |
| Show sub bookings | boolean |
| Show external events | boolean |
| Blocker style | text |
| Days before | number |
| Days after | number |
| Locale | text |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Meta | object |
| Calendar URL | text |
Create Timeslot Resource AllocationAction
| Field | Type |
|---|---|
| Attributes | object |
| Capacity Multiplier | number |
| Imputed Costs | number |
| Is Required | boolean |
| Order Index | number |
| Status | choice |
| Visible To Customer | boolean |
| Relationships | object |
| Resource | object |
| Timeslot | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Status | text |
| Capacity multiplier | number |
| Order index | number |
| Imputed costs | text |
| Is externally blocked | boolean |
| Is required | boolean |
| Provisioned at | text |
| Provisioned by booking ID | text |
| Visible to customer | boolean |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslot | object |
Delete a BookingAction
| Field | Type |
|---|---|
IDRequired | choice |
| Organization ID | choice |
Delete a Broadcast CampaignAction
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
Delete a BusinessAction
| Field | Type |
|---|---|
Business IDRequired | choice |
Delete a CommunityAction
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Color | text |
| Icon | text |
| Welcome text | text |
| Is private | boolean |
| Allow customer requests | boolean |
| Allow organization requests | boolean |
| Auto join enabled | boolean |
| Auto join settings | text |
| Links | object |
| Self | text |
| Relationships | object |
| Domains | object |
| Logo image | object |
| Resources | object |
| Resource groups | object |
| Services | object |
| Organizations | object |
| Owner organization | object |
| Community accounts | object |
| Unpersonalized invite | object |
| Booking quotas | object |
| Meta | object |
| Members count | number |
Delete a CustomerAction
| Field | Type |
|---|---|
Customer IDRequired | choice |
Delete a Customer BalanceAction
| Field | Type |
|---|---|
Customer Balance UUIDRequired | choice |
Delete a PropertyAction
| Field | Type |
|---|---|
Property IDRequired | choice |
Delete a ResourceAction
| Field | Type |
|---|---|
Resource IDRequired | choice |
Delete a Resource GroupAction
| Field | Type |
|---|---|
Resource Group IDRequired | choice |
Delete a ScheduleAction
| Field | Type |
|---|---|
Schedule IDRequired | choice |
Delete a ServiceAction
| Field | Type |
|---|---|
Service IDRequired | choice |
Delete a TestAction
| Field | Type |
|---|---|
Test IDRequired | choice |
Delete a TimeslotAction
| Field | Type |
|---|---|
Timslot IDRequired | choice |
Delete a Timeslot Resource AllocationAction
| Field | Type |
|---|---|
Timeslot Resource Allocation IDRequired | choice |
Delete a Timeslot SeriesAction
| Field | Type |
|---|---|
IDRequired | choice |
Delete a VoucherAction
| Field | Type |
|---|---|
Voucher IDRequired | choice |
Delete an Add-onAction
| Field | Type |
|---|---|
Add-on IDRequired | choice |
Delete an Add-on GroupAction
| Field | Type |
|---|---|
Add-on Group IDRequired | choice |
Delete an ICS CalendarAction
| Field | Type |
|---|---|
ISC Calendar IDRequired | choice |
Delete an ImageAction
| Field | Type |
|---|---|
Image IDRequired | choice |
Delete an InvoiceAction
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Delete an OrderAction
| Field | Type |
|---|---|
Order IDRequired | choice |
Delete Community InviteAction
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Color | text |
| Icon | text |
| Welcome text | text |
| Is private | boolean |
| Allow customer requests | boolean |
| Allow organization requests | boolean |
| Auto join enabled | boolean |
| Auto join settings | text |
| Links | object |
| Self | text |
| Relationships | object |
| Domains | object |
| Logo image | object |
| Resources | object |
| Resource groups | object |
| Services | object |
| Organizations | object |
| Owner organization | object |
| Community accounts | object |
| Unpersonalized invite | object |
| Booking quotas | object |
| Meta | object |
| Members count | number |
Duplicate a ServiceAction
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | text |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | text |
| Allow cross schedule | text |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
Make an API Calluniversal
Mark Invoice as PaidAction
| Field | Type |
|---|---|
| Send Notification | boolean |
Merge CustomersAction
| Field | Type |
|---|---|
Source Customer UUIDRequired | choice |
Target Customer UUIDRequired | choice |
Move Invoice to BalanceAction
| Field | Type |
|---|---|
Invoice IDRequired | choice |
Balanceable IDRequired | choice |
Balanceable TypeRequired | choice |
| Issued At | date |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Formatted number | text |
| Currency | text |
| Is cancellation | boolean |
| Is credit | boolean |
| Has payment | boolean |
| Show transfer note | boolean |
| Vat number | text |
| Notes | text |
| Recipient | text |
| Links | object |
| Self | text |
| Relationships | object |
| Order | object |
| Items | object |
| Payments | object |
| Organization | object |
Preview Recurring Timeslot OccurrencesAction
Resend Community InviteAction
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Color | text |
| Icon | text |
| Welcome text | text |
| Is private | boolean |
| Allow customer requests | boolean |
| Allow organization requests | boolean |
| Auto join enabled | boolean |
| Auto join settings | text |
| Links | object |
| Self | text |
| Relationships | object |
| Domains | object |
| Logo image | object |
| Resources | object |
| Resource groups | object |
| Services | object |
| Organizations | object |
| Owner organization | object |
| Community accounts | object |
| Unpersonalized invite | object |
| Booking quotas | object |
| Meta | object |
| Members count | number |
Resend Order EmailAction
| Field | Type |
|---|---|
Order IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
Send an InvoiceAction
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Formatted number | text |
| Currency | text |
| Is cancellation | boolean |
| Is credit | boolean |
| Has payment | boolean |
| Show transfer note | boolean |
| Vat number | text |
| Notes | text |
| Recipient | text |
| Links | object |
| Self | text |
| Relationships | object |
| Order | object |
| Items | object |
| Payments | object |
| Organization | object |
Start Broadcast CampaignAction
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Scheduled at | text |
| Status | text |
| Total count | number |
| Failed count | number |
| Sent count | number |
| Recurring | boolean |
| Cron | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Template | object |
| Audience | object |
Stop Broadcast CampaignAction
| Field | Type |
|---|---|
Broadcast Campaign IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Scheduled at | text |
| Status | text |
| Total count | number |
| Failed count | number |
| Sent count | number |
| Recurring | boolean |
| Cron | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Template | object |
| Audience | object |
Sync Community Auto JoinAction
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Color | text |
| Icon | text |
| Welcome text | text |
| Is private | boolean |
| Allow customer requests | boolean |
| Allow organization requests | boolean |
| Auto join enabled | boolean |
| Auto join settings | text |
| Links | object |
| Self | text |
| Relationships | object |
| Domains | object |
| Logo image | object |
| Resources | object |
| Resource groups | object |
| Services | object |
| Organizations | object |
| Owner organization | object |
| Community accounts | object |
| Unpersonalized invite | object |
| Booking quotas | object |
| Meta | object |
| Members count | number |
Sync Community QuotasAction
| Field | Type |
|---|---|
IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Color | text |
| Icon | text |
| Welcome text | text |
| Is private | boolean |
| Allow customer requests | boolean |
| Allow organization requests | boolean |
| Auto join enabled | boolean |
| Auto join settings | text |
| Links | object |
| Self | text |
| Relationships | object |
| Domains | object |
| Logo image | object |
| Resources | object |
| Resource groups | object |
| Services | object |
| Organizations | object |
| Owner organization | object |
| Community accounts | object |
| Unpersonalized invite | object |
| Booking quotas | object |
| Meta | object |
| Members count | number |
Update a BookingAction
| Field | Type |
|---|---|
IDRequired | choice |
| Attributes | object |
| Blocker End Date | date |
| Blocker Start Date | date |
| Can Edit | boolean |
| Canceled At | date |
| Charged Duration | number |
| Charged Subtotal | number |
| Charged Total | number |
| Check In Date | date |
| Check Out Date | date |
| Code | text |
| Links | object |
| Self | url |
| Relationships | object |
| Access Control Grants | object |
| Activities | object |
| Attendees | object |
| Booking Add Ons | array |
| Booking Participants | array |
| Booking Series | object |
| Cancellation Policy | object |
| Custom Entries | array |
| Customer | object |
| Delegated By | object |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Number | text |
| Status | text |
| Is blocker | boolean |
| Start date | date |
| End date | date |
| Blocker start date | date |
| Blocker end date | date |
| Description | text |
| Charged duration | number |
| Weight | number |
| Links | object |
| Self | text |
| Meta | array |
Update a BusinessAction
| Field | Type |
|---|---|
Business IDRequired | choice |
TypeRequired | choice |
AttributesRequired | object |
NameRequired | text |
| Billing Email | |
| Brand Name | text |
| Domain | text |
| Notes | text |
| VAT ID | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Brand name | text |
| Domain | text |
| Billing email | |
| Vat ID | text |
| Notes | text |
| Custom entry map | object |
| Created at | date |
| Updated at | date |
| Meta | object |
| Has business account | boolean |
| Links | object |
| Self | text |
| Relationships | object |
| Billing address | object |
| Logo image | object |
| Customers | object |
| Custom entries | object |
| Customer balances | object |
| Payment setup | object |
Update a CustomerAction
| Field | Type |
|---|---|
Customer IDRequired | choice |
| Attributes | object |
| Locale | text |
| Title | text |
| Sex | number |
| Birth Date | date |
| Given Name | text |
| Family Name | text |
| Mobile | text |
| Company | text |
| Custom Entry Map | object |
| Relationships | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| UUID | text |
| Number | text |
| Locale | text |
| Title | text |
| Given name | text |
| Family name | text |
| Full name | text |
| Sex | text |
| Birth date | date |
| Links | object |
| Self | text |
| Relationships | object |
| Address | object |
| Delivery address | object |
| Business | object |
| Custom entries | object |
| Orders | object |
| Model identifiers | object |
| Subscriptions | object |
| Communities | object |
| Community invites | object |
| Document acceptances | object |
| Meta | object |
| Has account | boolean |
| External ID | text |
| Idp user ID | text |
Update a Customer BalanceAction
| Field | Type |
|---|---|
Customer Balance UUIDRequired | choice |
TypeRequired | choice |
| Attributes | object |
| Status | choice |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | text |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | text |
| Allow cross schedule | text |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
Update a PropertyAction
| Field | Type |
|---|---|
Property IDRequired | choice |
| Attributes | object |
| Filterable | text |
| Icon | text |
| Label | text |
| Private | text |
| Value Type | text |
| Meta | array |
| Relationships | object |
| Category | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Label | text |
| Icon | text |
| Value type | text |
| Filterable | boolean |
| Private | boolean |
| Links | object |
| Self | text |
| Relationships | object |
| Resource properties | object |
| Meta | object |
| Options | array |
Update a ResourceAction
| Field | Type |
|---|---|
Resource IDRequired | choice |
| Attributes | object |
| Archived | boolean |
| Availability Mode | text |
| Bookings Enabled | boolean |
| Color | text |
| Color Map | object |
| Created At | text |
| Description | text |
| Display Public Description | boolean |
| Email Info | text |
| Links | object |
| Self | url |
| Meta | object |
| Minimal Service | object |
| Relationships | object |
| Category | object |
| Children | object |
| Communities | object |
| Cover Image | object |
| External Calendars | object |
| Featured Properties | object |
| Files | object |
| Gallery Images | object |
| Location | object |
| Logo Image | object |
| Type | text |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Slug | text |
| Name | text |
| Description | text |
| Plain description | text |
| Availability mode | text |
| Continuous | boolean |
| Color | text |
| Auto accept bookings | boolean |
| Timezone | text |
| Quantity | number |
| Links | object |
| Self | text |
| Meta | object |
| Is available | text |
| Booking count | text |
| Number available | text |
| Minimal service | object |
| Service list | text |
| Services count | number |
| Settings | object |
| Meta settings | object |
| Zoom | boolean |
| Client URL | url |
Update a Resource GroupAction
Update a ScheduleAction
| Field | Type |
|---|---|
Schedule IDRequired | text |
| Attributes | object |
| Local End Time | time |
| Local Start Time | time |
| Quota | text |
| Weekday | number |
| Meta | array |
| Relationships | object |
| Types | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Start time | text |
| Local start time | text |
| End time | text |
| Local end time | text |
| Timezone | text |
| Weekday | number |
| Quota | number |
| Links | object |
| Self | url |
Update a ServiceAction
| Field | Type |
|---|---|
Service IDRequired | choice |
Service IDRequired | choice |
| Attributes | object |
| Access Code | text |
| Advance Booking Period | text |
| Allow Customer Notes | text |
| Allow More Bookings | text |
| Booking Interval | text |
| Calculation Interval | text |
| Currency | text |
| Default Weight | text |
| Description | text |
| Has Flexible Duration | text |
| Type | text |
| Meta | array |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Slug | text |
| Description | text |
| Hidden | text |
| Is rental option | boolean |
| Has flexible duration | boolean |
| Auto duration | text |
| Allow cross schedule | text |
| Requires booking description | boolean |
| Requires address | boolean |
| Links | object |
| Self | text |
| Meta | object |
| Resource list | text |
| Min duration total | number |
Update a TestAction
| Field | Type |
|---|---|
Test IDRequired | choice |
| Attributes | object |
| Name | text |
| Display Tester | boolean |
| Validate Download | boolean |
| Auto Result | text |
| Auto Result Delay | number |
| Certificate Body | text |
| Certificate Footer | text |
| Default Test Type | text |
| Doctor Name | text |
| Issuing Authority | text |
| Meta | object |
| Relationships | object |
| Custom Fields | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Result options | array |
| Auto result | text |
| Auto result delay | number |
| Certificate body | text |
| Certificate footer | text |
| Issuing authority | text |
| Doctor name | text |
| Valid period | number |
| Test type options | array |
| Links | object |
| Self | text |
Update a TimeslotAction
| Field | Type |
|---|---|
Timslot IDRequired | choice |
| Include | choice |
| Sync Bookings | choice |
| Status Reason | text |
| Send Notification | choice |
| Lock Invoice | choice |
| Attributes | object |
| Base Quota | number |
| Cancellation Offset Type | text |
| Cancellation Offset Value | number |
| Description | text |
| Description I18N | object |
| Dynamic Capacity | boolean |
| End Date | date |
| Max Dynamic Quota | number |
| Min Bookings Count | number |
| Quota | number |
| Meta | array |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Title | text |
| Title i 18n | object |
| Description | text |
| Description i 18n | object |
| Start date | date |
| End date | date |
| Timezone | text |
| Quota | text |
| Resource info | array |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Service | object |
| Series | object |
| Cover image | object |
| Resource allocations | object |
| Model syncs | object |
| Meta | object |
| Provisioned quota | number |
| Active booking count | number |
| Pending booking count | number |
| Total booking count | number |
| Available provisioned slots | number |
| Pending capacity | number |
| Protected | array |
Update a Timeslot Resource AllocationAction
| Field | Type |
|---|---|
Timeslot Resource Allocation IDRequired | choice |
| Attributes | object |
| Capacity Multiplier | number |
| Imputed Costs | number |
| Is Required | boolean |
| Order Index | number |
| Status | choice |
| Visible To Customer | boolean |
| Relationships | object |
| Resource | object |
| Timeslot | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Status | text |
| Capacity multiplier | number |
| Order index | number |
| Imputed costs | text |
| Is externally blocked | boolean |
| Is required | boolean |
| Provisioned at | text |
| Provisioned by booking ID | text |
| Visible to customer | boolean |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslot | object |
Update a Timeslot SeriesAction
| Field | Type |
|---|---|
IDRequired | choice |
AttributesRequired | object |
NameRequired | text |
| Local Name i18n | object |
| Relationships | object |
| Resource | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Start date | date |
| End date | date |
| Created at | date |
| Updated at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resource | object |
| Timeslots | object |
Update a VoucherAction
| Field | Type |
|---|---|
Voucher IDRequired | choice |
| Type | text |
| Attributes | object |
| Absolute Discount | number |
| Code | text |
| Currency | text |
| Expires At | date |
| Include Add Ons | boolean |
| Relative Discount | number |
| Meta | array |
| Relationships | object |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Code | text |
| Absolute discount | text |
| Currency | text |
| Relative discount | text |
| Number available | number |
| Expires at | date |
| Include add ons | boolean |
| Description | text |
| Created at | date |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Orders | object |
Update an Add-onAction
| Field | Type |
|---|---|
Add-on IDRequired | choice |
| Attributes | object |
| Currency | text |
| Customer Notice | text |
| Description | text |
| Is Net Price | boolean |
| Is Third Party | boolean |
| Lead Time | number |
| Name | text |
| Plain Description | text |
| Price | number |
| Tax Rate | number |
| Relationships | text |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| Type | text |
| ID | text |
| Attributes | object |
| Name | text |
| Description | text |
| Plain description | text |
| Customer notice | text |
| Lead time | number |
| Is third party | boolean |
| Is net price | boolean |
| Currency | text |
| Tax rate | number |
| Price | number |
| Links | object |
| Self | url |
Update an ImageAction
Update an InvoiceAction
| Field | Type |
|---|---|
Invoice IDRequired | choice |
| Attributes | object |
| Access Token | text |
| Created At | text |
| Currency | text |
| Due Date | date |
| Formatted Number | text |
| Has Payment | boolean |
| Invoicing Party | text |
| Is Cancellation | boolean |
| Is Credit | boolean |
| Is Processing | boolean |
| Links | object |
| Self | url |
| Relationships | object |
| Items | object |
| Order | object |
| Organization | object |
| Payments | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Formatted number | text |
| Currency | text |
| Is cancellation | boolean |
| Is credit | boolean |
| Has payment | boolean |
| Show transfer note | boolean |
| Vat number | text |
| Notes | text |
| Recipient | text |
| Links | object |
| Self | text |
| Relationships | object |
| Order | object |
| Items | object |
| Payments | object |
| Organization | object |
Update an OrderAction
| Field | Type |
|---|---|
Order IDRequired | choice |
| Attributes | object |
| Currency | text |
| Status | text |
| Relationships | object |
| Customer | object |
| Bookings | object |
| Meta | array |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Number | text |
| Currency | text |
| Total | number |
| Modification total | number |
| Net amount | number |
| Tax amount | number |
| Discount amount | number |
| System fee | number |
| Status | text |
| Access token | text |
| Links | object |
| Self | text |
| Relationships | object |
| Bookings | object |
| Customer | object |
| Organization | object |
| Invoice | object |
| Invoice history | object |
| Tmp invoice | object |
| Last payment | object |
| Payments | object |
| Voucher | object |
| Sub orders | object |
Update ICS CalendarAction
| Field | Type |
|---|---|
ISC Calendar IDRequired | choice |
| Attributes | object |
| Blocker Style | text |
| Days After | text |
| Days Before | text |
| Locale | text |
| Name | text |
| Show Add Ons | text |
| Show Customer | text |
| Show Description | text |
| Show External Events | text |
| Show Sub Bookings | text |
| Meta | array |
| Relationships | object |
| Resources | object |
| Type | text |
| Field | Type |
|---|---|
| ID | text |
| Type | text |
| Attributes | object |
| Name | text |
| Show description | boolean |
| Show customer | boolean |
| Show add ons | boolean |
| Show sub bookings | boolean |
| Show external events | boolean |
| Blocker style | text |
| Days before | number |
| Days after | number |
| Locale | text |
| Links | object |
| Self | text |
| Relationships | object |
| Resources | object |
| Meta | object |
| Calendar URL | text |
Templates
Look for Anny Admin API templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Anny Customer API[2]Online booking and scheduling platform that lets customers book resources, services, and appointments in real time.
- AgendizeOnline appointment scheduling and customer engagement platform for businesses.
- AmeliaWordPress booking and appointment scheduling for services and events.
- AppointeddOnline booking and appointment scheduling for retail and service businesses.
- BookedSchedulerResource reservation and scheduling platform for booking rooms, equipment, and shared assets.
References
- WEXTL® Anny Admin API Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Anny Admin API.
- WEXTL® visual workflow builder data.
Last updated: Jul 21, 2026 15:22
