KC (versión preliminar)
KC Practice Management permite el acceso seguro a los datos empresariales y de cliente, lo que permite a los usuarios recuperar y administrar información de forma eficaz a través de flujos de trabajo automatizados.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Kloud Connect |
| DIRECCIÓN URL | https://www.kloudconnect.com.au/ |
| support@kloudconnect.com.au |
| Metadatos del conector | |
|---|---|
| Publicador | Kloud Connect |
| Sitio web | https://www.kloudconnect.com.au/ |
| Directiva de privacidad | https://www.kloudconnect.com.au/wp-content/uploads/2024/09/Privacy-Policy-Kloud-Connect.pdf |
| Categorías | Gestión empresarial; Finanzas |
Administración de prácticas de Kloud Connect
Visión general
Esto proporciona acceso a las API de administración de prácticas de Kloud Connect.
Características
- Enumerar clientes
- Crear clientes
- Enumerar contactos
- Crear contactos
- Enumerar facturas
- Crear parte de horas
- Enumerar tareas
- Crear tareas
- Listar trabajos
- Creación de trabajos
- Datos de administración de prácticas de acceso
Autenticación
OAuth 2.0 a través de Kloud Connect Identity Server
Apoyo
support@kloudconnect.com.au
Acciones
| Actualizar contacto |
Actualiza un contacto por identificador. |
| Actualizar el cliente por identificador |
Actualiza un cliente por identificador. |
| Actualizar el estado y la prioridad del trabajo |
Actualiza el estado y la prioridad de los trabajos de flujo de trabajo. |
| Actualizar grupo de clientes |
Actualiza un grupo de clientes por código de grupo. |
| Actualizar trabajo |
Actualiza un trabajo de flujo de trabajo por identificador. |
| Creación de un grupo de clientes |
Crea un grupo de clientes. |
| Creación del trabajo |
Crea un trabajo de flujo de trabajo. |
| Crear el cliente |
Crea un cliente. |
| Enumeración de tipos de hora no facturables |
Devuelve los tipos de parte de horas no facturables disponibles. |
| Enumerar clientes |
Devuelve una lista paginada de clientes. |
| Enumerar contactos |
Devuelve una lista paginada de contactos. |
| Enumerar divisiones |
Devuelve una lista paginada de divisiones. |
| Enumerar etiquetas de cliente |
Devuelve las etiquetas de cliente disponibles. |
| Enumerar facturas |
Devuelve una lista paginada de facturas. |
| Enumerar las relaciones de cliente |
Devuelve una lista paginada de relaciones de cliente. |
| Enumerar los estados del tipo de trabajo |
Devuelve los estados de tipo de trabajo de flujo de trabajo disponibles. |
| Enumerar plantillas de trabajo |
Devuelve las plantillas de trabajo de flujo de trabajo disponibles. |
| Enumerar prioridades de trabajo |
Devuelve las prioridades de trabajo de flujo de trabajo disponibles. |
| Enumerar tipos de trabajo |
Devuelve los tipos de trabajo de flujo de trabajo disponibles. |
| Enumerar trabajos |
Devuelve una lista paginada de trabajos de flujo de trabajo. |
| Hora del registro |
Crea una entrada de hora del parte de horas. |
| Incluir en una lista los equipos |
Devuelve los equipos disponibles. |
| Listar usuarios |
Devuelve una lista paginada de usuarios. |
| Obtención de la asignación de clientes deudores |
Devuelve la asignación de clientes deudores para un cliente. |
| Obtención del cliente por identificador |
Devuelve los detalles de un cliente por identificador. |
| Obtener campos personalizados por contexto |
Devuelve campos personalizados para el contexto especificado. |
| obtener grupos de clientes |
obtener grupos de clientes |
Actualizar contacto
Actualiza un contacto por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contactId | True | integer |
Identificador de contacto. |
|
saludo
|
salutation | string | ||
|
firstName
|
firstName | True | string | |
|
Nombre del medio
|
middleName | string | ||
|
lastName
|
lastName | True | string | |
|
género
|
gender | string | ||
|
type
|
type | string | ||
|
número
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
companyName
|
companyName | string | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
linkedInProfileID
|
linkedInProfileID | string | ||
|
preferredName
|
preferredName | string | ||
|
din
|
din | string | ||
|
dateOfBirth
|
dateOfBirth | date-time | ||
|
isImportent
|
isImportent | boolean | ||
|
addressType
|
addressType | string | ||
|
unidad
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
addressLine2
|
addressLine2 | string | ||
|
suburbio
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
Cp
|
postCode | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Actualizar el cliente por identificador
Actualiza un cliente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id de cliente
|
clientId | True | integer |
Identificador del cliente. |
|
tipoDeEntidad
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
saludo
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
Nombre del medio
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
tipo de confianza
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
tradingName
|
tradingName | string | ||
|
partnershipName
|
partnershipName | string | ||
|
smsfName
|
smsfName | string | ||
|
softwareType
|
softwareType | string | ||
|
softwareName
|
softwareName | string | ||
|
partnerId
|
partnerId | True | string | |
|
managerId
|
managerId | string | ||
|
divisionId
|
divisionId | True | integer | |
|
prospect
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
género
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
número
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
sitio web
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
unidad
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
addressLine2
|
addressLine2 | string | ||
|
suburbio
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
Cp
|
postCode | string | ||
|
industria
|
industry | string | ||
|
role
|
role | string | ||
|
sueldo
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
enlatar
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
residente
|
resident | boolean | ||
|
bankName
|
bankName | string | ||
|
bankAccountName
|
bankAccountName | string | ||
|
bankBSB
|
bankBSB | integer | ||
|
bankAccountNumber
|
bankAccountNumber | integer | ||
|
contactId
|
contactId | integer | ||
|
contactType
|
contactType | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumEntityTypes
|
enumEntityTypes | string | ||
|
enumTrustTypes
|
enumTrustTypes | string | ||
|
enumGender
|
enumGender | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Actualizar el estado y la prioridad del trabajo
Actualiza el estado y la prioridad de los trabajos de flujo de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
jobId
|
jobId | integer | ||
|
prioridad
|
priority | string | ||
|
estado
|
status | string | ||
|
statusOwner
|
statusOwner | string |
Actualizar grupo de clientes
Actualiza un grupo de clientes por código de grupo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Código de grupo
|
groupCode | True | string |
Código de grupo de clientes. |
|
groupName
|
groupName | string | ||
|
partnerId
|
partnerId | string | ||
|
tags
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
contactId
|
contactId | integer |
Actualizar trabajo
Actualiza un trabajo de flujo de trabajo por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del trabajo
|
jobId | True | integer |
Identificador de trabajo de flujo de trabajo. |
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
deudorclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
nombreTrabajo
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
dueDate
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
prioridad
|
priority | string | ||
|
description
|
description | string | ||
|
billingMethod
|
billingMethod | string | ||
|
teamId
|
teamId | integer | ||
|
quoteAmount
|
quoteAmount | double | ||
|
statusId
|
statusId | integer | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string | ||
|
enumEstimateTypes
|
enumEstimateTypes | string | ||
|
enumBillingMethods
|
enumBillingMethods | string | ||
|
enumPriorityTypes
|
enumPriorityTypes | string |
Creación de un grupo de clientes
Crea un grupo de clientes.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
groupName
|
groupName | string | ||
|
partnerId
|
partnerId | string | ||
|
tags
|
tags | array of integer | ||
|
clientId
|
clientId | integer | ||
|
isDebitorClient
|
isDebitorClient | boolean | ||
|
relationIds
|
relationIds | array of integer | ||
|
contactId
|
contactId | integer |
Creación del trabajo
Crea un trabajo de flujo de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
clientId
|
clientId | integer | ||
|
divisionId
|
divisionId | integer | ||
|
deudorclientId
|
debtorclientId | integer | ||
|
jobTypeId
|
jobTypeId | integer | ||
|
jobCategory
|
jobCategory | string | ||
|
nombreTrabajo
|
jobName | string | ||
|
financialYear
|
financialYear | integer | ||
|
templateId
|
templateId | integer | ||
|
managerId
|
managerId | string | ||
|
partnerId
|
partnerId | string | ||
|
startDate
|
startDate | date-time | ||
|
dueDate
|
dueDate | date-time | ||
|
estimateType
|
estimateType | string | ||
|
prioridad
|
priority | string | ||
|
description
|
description | string | ||
|
billingMethod
|
billingMethod | string | ||
|
teamId
|
teamId | integer | ||
|
quoteAmount
|
quoteAmount | double | ||
|
statusId
|
statusId | integer | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumJobCategoryTypes
|
enumJobCategoryTypes | string | ||
|
enumEstimateTypes
|
enumEstimateTypes | string | ||
|
enumBillingMethods
|
enumBillingMethods | string | ||
|
enumPriorityTypes
|
enumPriorityTypes | string |
Crear el cliente
Crea un cliente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
tipoDeEntidad
|
entityType | True | string | |
|
clientCode
|
clientCode | True | string | |
|
saludo
|
salutation | string | ||
|
firstName
|
firstName | string | ||
|
Nombre del medio
|
middleName | string | ||
|
lastName
|
lastName | string | ||
|
trustName
|
trustName | string | ||
|
tipo de confianza
|
trustType | string | ||
|
companyName
|
companyName | string | ||
|
tradingName
|
tradingName | string | ||
|
partnershipName
|
partnershipName | string | ||
|
smsfName
|
smsfName | string | ||
|
softwareType
|
softwareType | string | ||
|
softwareName
|
softwareName | string | ||
|
partnerId
|
partnerId | True | string | |
|
managerId
|
managerId | string | ||
|
divisionId
|
divisionId | True | integer | |
|
prospect
|
prospect | boolean | ||
|
preferredName
|
preferredName | string | ||
|
dateofbirth
|
dateofbirth | date-time | ||
|
placeOfBirth
|
placeOfBirth | string | ||
|
género
|
gender | string | ||
|
type
|
type | string | ||
|
email
|
string | |||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
type
|
type | string | ||
|
número
|
number | string | ||
|
favorito
|
favourite | boolean | ||
|
feeSynergy
|
feeSynergy | boolean | ||
|
linkedInProfileId
|
linkedInProfileId | string | ||
|
sitio web
|
website | string | ||
|
annualReviewDate
|
annualReviewDate | date-time | ||
|
formationDate
|
formationDate | date-time | ||
|
addressType
|
addressType | string | ||
|
unidad
|
unit | string | ||
|
careOf
|
careOf | string | ||
|
addressLine1
|
addressLine1 | string | ||
|
addressLine2
|
addressLine2 | string | ||
|
suburbio
|
suburb | string | ||
|
state
|
state | string | ||
|
country
|
country | string | ||
|
Cp
|
postCode | string | ||
|
industria
|
industry | string | ||
|
role
|
role | string | ||
|
sueldo
|
salary | string | ||
|
annualIncome
|
annualIncome | string | ||
|
isTaxClient
|
isTaxClient | boolean | ||
|
isLodgeActivity
|
isLodgeActivity | boolean | ||
|
Tfn
|
tfn | integer | ||
|
Abn
|
abn | integer | ||
|
enlatar
|
acn | integer | ||
|
din
|
din | integer | ||
|
taxAgent
|
taxAgent | string | ||
|
Gst
|
gst | boolean | ||
|
residente
|
resident | boolean | ||
|
bankName
|
bankName | string | ||
|
bankAccountName
|
bankAccountName | string | ||
|
bankBSB
|
bankBSB | integer | ||
|
bankAccountNumber
|
bankAccountNumber | integer | ||
|
contactId
|
contactId | integer | ||
|
contactType
|
contactType | string | ||
|
id
|
id | integer | ||
|
value
|
value | string | ||
|
enumEntityTypes
|
enumEntityTypes | string | ||
|
enumTrustTypes
|
enumTrustTypes | string | ||
|
enumGender
|
enumGender | string | ||
|
enumEmailTypes
|
enumEmailTypes | string | ||
|
enumPhoneTypes
|
enumPhoneTypes | string | ||
|
enumContactTypes
|
enumContactTypes | string | ||
|
enumAddressTypes
|
enumAddressTypes | string |
Enumeración de tipos de hora no facturables
Devuelve los tipos de parte de horas no facturables disponibles.
Enumerar clientes
Devuelve una lista paginada de clientes.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página de resultados (basado en 1). |
|
|
Tamaño de página
|
pageSize | integer |
Número de artículos por página. |
|
|
ID de socio
|
partnerId | string |
Filtre por identificador de asociado. |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtre por marca de cliente de débito. |
|
|
Modificado desde
|
modifiedSince | string |
Devuelve los clientes modificados en/después de esta marca de tiempo (ISO 8601). |
|
|
Código de grupo
|
groupCode | string |
Filtre por código de grupo. |
|
|
Id de cliente
|
clientId | integer |
Filtre por identificador de cliente. |
|
|
Campos personalizados
|
isCustomField | boolean |
Incluir campos personalizados. |
Devoluciones
- Body
- Client_Result
Enumerar contactos
Devuelve una lista paginada de contactos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página de resultados. |
|
|
Tamaño de página
|
pageSize | integer |
Número de contactos que se van a devolver por página. |
|
|
Modificado desde
|
modifiedSince | string |
Devuelve los contactos modificados en o después de esta marca de tiempo. |
|
|
ID de contacto
|
contactId | integer |
Filtre los contactos por identificador de contacto. |
|
|
Filtro de id. de cliente
|
isClientId | boolean |
Indica si el filtro de identificador de contacto debe tratarse como un identificador de cliente. |
|
|
Campos personalizados
|
isCustomField | boolean |
Incluya campos personalizados en los resultados del contacto. |
Devoluciones
- Body
- Contact_Result
Enumerar divisiones
Devuelve una lista paginada de divisiones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página de resultados. |
|
|
Tamaño de página
|
pageSize | integer |
Número de divisiones que se van a devolver por página. |
|
|
Modificado desde
|
modifiedSince | string |
Devuelve divisiones modificadas en o después de esta marca de tiempo. |
Devoluciones
- Body
- Divisions_Result
Enumerar etiquetas de cliente
Devuelve las etiquetas de cliente disponibles.
Enumerar facturas
Devuelve una lista paginada de facturas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página de resultados. |
|
|
Tamaño de página
|
pageSize | integer |
Número de facturas que se van a devolver por página. |
|
|
Borrador de factura
|
isDraftInvoice | boolean |
Filtre las facturas por marca de factura de borrador. |
|
|
Incluir detalles de factura
|
includeInvoiceDetails | boolean |
Incluya registros de detalles de factura en la respuesta. |
|
|
Situación
|
status | string |
Filtre las facturas por estado. |
|
|
Modificado desde
|
modifiedSince | string |
Devuelve facturas modificadas en esta marca de tiempo o después de esta marca de tiempo. |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtre las facturas por marca de cliente de débito. |
|
|
Nombre de cliente
|
clientname | string |
Filtre las facturas por nombre de cliente. |
|
|
Código de cliente
|
clientcode | string |
Filtre las facturas por código de cliente. |
|
|
Nombre del trabajo
|
jobname | string |
Filtre las facturas por nombre del trabajo. |
|
|
Código de trabajo
|
jobcode | string |
Filtre las facturas por código de trabajo. |
|
|
Identificador de entidad de facturación
|
billingEntityId | string |
Filtre las facturas por identificador de entidad de facturación. |
Devoluciones
- Body
- InvoiceDetail_Result
Enumerar las relaciones de cliente
Devuelve una lista paginada de relaciones de cliente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id de cliente
|
clientId | True | integer |
Identificador del cliente. |
|
Página
|
page | integer |
Número de página de resultados. |
|
|
Tamaño de página
|
pageSize | integer |
Número de relaciones que se van a devolver por página. |
Devoluciones
- Body
- Relationships_Result
Enumerar los estados del tipo de trabajo
Devuelve los estados de tipo de trabajo de flujo de trabajo disponibles.
Devoluciones
- Body
- JobTypeStatus
Enumerar plantillas de trabajo
Enumerar prioridades de trabajo
Devuelve las prioridades de trabajo de flujo de trabajo disponibles.
Devoluciones
- Body
- JobPriorityValues
Enumerar tipos de trabajo
Enumerar trabajos
Devuelve una lista paginada de trabajos de flujo de trabajo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página de resultados. |
|
|
Tamaño de página
|
pageSize | integer |
Número de trabajos que se van a devolver por página. |
|
|
ID de socio
|
partnerId | string |
Filtre los trabajos por identificador de asociado. |
|
|
Nombre de cliente
|
clientName | string |
Filtre los trabajos por nombre de cliente. |
|
|
Código de cliente
|
clientcode | string |
Filtre los trabajos por código de cliente. |
|
|
Modificado desde
|
modifiedSince | string |
Devuelve trabajos modificados en o después de esta marca de tiempo. |
|
|
Cliente de débito
|
isDebitClient | boolean |
Filtre los trabajos por marca de cliente de débito. |
|
|
Campos personalizados
|
isCustomField | boolean |
Incluya campos personalizados en los resultados del trabajo. |
Devoluciones
- Body
- Jobs_Result
Hora del registro
Crea una entrada de hora del parte de horas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
isbillable
|
isbillable | boolean | ||
|
jobId
|
jobId | integer | ||
|
taskId
|
taskId | integer | ||
|
nonbillableId
|
nonbillableId | integer | ||
|
date
|
date | date | ||
|
unidades
|
units | double | ||
|
hora de inicio
|
starttime | string | ||
|
tasa
|
rate | double | ||
|
description
|
description | string |
Incluir en una lista los equipos
Listar usuarios
Devuelve una lista paginada de usuarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página de resultados. |
|
|
Tamaño de página
|
pageSize | integer |
Número de usuarios que se van a devolver por página. |
|
|
Modificado desde
|
modifiedSince | string |
Devuelve los usuarios modificados en esta marca de tiempo o después de esta marca de tiempo. |
|
|
Nombre del rol
|
rolename | string |
Filtre los usuarios por nombre de rol. |
Devoluciones
- Body
- Users_Result
Obtención de la asignación de clientes deudores
Devuelve la asignación de clientes deudores para un cliente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id de cliente
|
clientId | True | integer |
Identificador del cliente. |
Devoluciones
- Body
- ClientDebtor
Obtención del cliente por identificador
Devuelve los detalles de un cliente por identificador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id de cliente
|
clientId | True | integer |
Identificador del cliente. |
|
Campos personalizados
|
isCustomField | boolean |
Incluir campos personalizados. |
Devoluciones
- Body
- ClientDetails_Result
Obtener campos personalizados por contexto
Devuelve campos personalizados para el contexto especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Context
|
context | True | string |
Contexto de campos personalizados. |
obtener grupos de clientes
obtener grupos de clientes
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
Número de página de resultados. |
|
|
Tamaño de página
|
pageSize | integer |
Número de grupos de clientes que se van a devolver por página. |
|
|
Código de grupo
|
groupCode | string |
Filtre los grupos de clientes por código de grupo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
clientGroups
|
clientGroups | array of object |
clientGroups |
|
groupId
|
clientGroups.groupId | integer |
groupId |
|
groupCode
|
clientGroups.groupCode | string |
groupCode |
|
groupName
|
clientGroups.groupName | string |
groupName |
|
contacto
|
clientGroups.contact | string |
contacto |
|
tags
|
clientGroups.tags | array of |
tags |
|
clients
|
clientGroups.clients | array of object |
clients |
|
clientId
|
clientGroups.clients.clientId | integer |
clientId |
|
tipoDeEntidad
|
clientGroups.clients.entityType | string |
tipoDeEntidad |
|
nombre de cliente
|
clientGroups.clients.clientname | string |
nombre de cliente |
|
isDebtorClient
|
clientGroups.clients.isDebtorClient | boolean |
isDebtorClient |
|
deudorClientId
|
clientGroups.clients.debtorClientId | integer |
deudorClientId |
|
createdBY
|
clientGroups.createdBY | string |
createdBY |
|
creado
|
clientGroups.created | string |
creado |
|
lastmodified
|
clientGroups.lastmodified | string |
lastmodified |
|
registros_totales
|
pagination.total_records | integer |
registros_totales |
|
current_page
|
pagination.current_page | integer |
current_page |
|
page_Size
|
pagination.page_Size | integer |
page_Size |
|
total_pages
|
pagination.total_pages | integer |
total_pages |
|
next_page
|
pagination.next_page | integer |
next_page |
|
next_pageurl
|
pagination.next_pageurl | string |
next_pageurl |
|
|
pagination.prev_page | integer |
prev_page |
|
prev_pageurl
|
pagination.prev_pageurl | string |
prev_pageurl |
Definiciones
Dirección
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
addressType
|
addressType | string | |
|
unidad
|
unit | string | |
|
careOf
|
careOf | string | |
|
addressLine1
|
addressLine1 | string | |
|
addressLine2
|
addressLine2 | string | |
|
suburbio
|
suburb | string | |
|
state
|
state | string | |
|
country
|
country | string | |
|
Cp
|
postCode | string |
Client
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string | |
|
saludo
|
salutation | string | |
|
nombre
|
name | string | |
|
firstName
|
firstName | string | |
|
Nombre del medio
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
división
|
division | Division | |
|
tipoDeEntidad
|
entityType | string | |
|
partner
|
partner | Staff | |
|
gerente
|
manager | Staff | |
|
contactos
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
enlatar
|
acn | string | |
|
Abn
|
abn | string | |
|
Tfn
|
tfn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string | |
|
wip
|
wip | string | |
|
location
|
location | string | |
|
estado
|
status | string | |
|
group
|
group | Group | |
|
deudorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField |
ClientDebtor
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
deudorid
|
debtorid | integer | |
|
nombre del deudor
|
debtorname | string | |
|
groupCode
|
groupCode | string | |
|
clientid
|
clientid | integer | |
|
clientType
|
clientType | string | |
|
isSeflDebtor
|
isSeflDebtor | boolean |
ClientDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string | |
|
saludo
|
salutation | string | |
|
nombre
|
name | string | |
|
firstName
|
firstName | string | |
|
Nombre del medio
|
middleName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
dateOfBirth
|
dateOfBirth | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone | |
|
división
|
division | Division | |
|
tipoDeEntidad
|
entityType | string | |
|
partner
|
partner | Staff | |
|
gerente
|
manager | Staff | |
|
contactos
|
contacts | array of Contact | |
|
addresses
|
addresses | array of Address | |
|
enlatar
|
acn | string | |
|
Abn
|
abn | string | |
|
gstRegistered
|
gstRegistered | boolean | |
|
taxClient
|
taxClient | boolean | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string | |
|
wip
|
wip | string | |
|
location
|
location | string | |
|
estado
|
status | string | |
|
group
|
group | Group | |
|
deudorClient
|
debtorClient | string | |
|
clientBrefcode
|
clientBrefcode | string | |
|
billercode
|
billercode | string | |
|
id
|
id | integer | |
|
customFields
|
customFields | array of CustomField | |
|
din
|
din | string | |
|
Tfn
|
tfn | string | |
|
bankName
|
bankName | string | |
|
bankAccountName
|
bankAccountName | string | |
|
bankBSB
|
bankBSB | string | |
|
bankAccountNumber
|
bankAccountNumber | string |
ClientDetails_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
cliente
|
client | array of ClientDetails |
ClientSummary
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
código
|
code | string | |
|
nombre
|
name | string |
Client_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
clients
|
clients | array of Client | |
|
paginación
|
pagination | Pagination |
Contacto
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
preferredName
|
preferredName | string | |
|
contactType
|
contactType | string | |
|
email
|
array of Email | ||
|
phone
|
phone | array of Phone |
ContactEntity
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
saludo
|
salutation | string | |
|
firstName
|
firstName | string | |
|
Nombre del medio
|
middleName | string | |
|
lastName
|
lastName | string | |
|
género
|
gender | string | |
|
phone
|
phone | array of Phone | |
|
email
|
array of Email | ||
|
companyName
|
companyName | string | |
|
placeOfBirth
|
placeOfBirth | string | |
|
linkedInProfileID
|
linkedInProfileID | string | |
|
preferredName
|
preferredName | string | |
|
din
|
din | string | |
|
contactId
|
contactId | integer | |
|
dateOfBirth
|
dateOfBirth | string | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string | |
|
addresses
|
addresses | array of Address | |
|
nombre
|
name | string | |
|
location
|
location | string | |
|
context
|
context | string | |
|
customFields
|
customFields | array of CustomField |
Contact_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
contactos
|
contacts | array of ContactEntity | |
|
paginación
|
pagination | Pagination |
CustomField
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
value
|
value | string |
Client deudor
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
código
|
code | string | |
|
nombre
|
name | string |
División
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nombre
|
name | string |
DivisionWithDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nombre
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
lastModifiedAt
|
lastModifiedAt | string |
Divisionext
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nombre
|
name | string | |
|
billingEntityName
|
billingEntityName | string | |
|
billingEntityId
|
billingEntityId | string | |
|
lastModifiedAt
|
lastModifiedAt | string | |
|
lastModifiedBy
|
lastModifiedBy | string | |
|
creado
|
created | string |
Divisions_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
divisiones
|
divisions | array of Divisionext | |
|
paginación
|
pagination | Pagination |
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | string | |
|
email
|
string | ||
|
favorito
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Grupo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
código
|
code | string | |
|
nombre
|
name | string |
Miembro del grupo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
memberId
|
memberId | string | |
|
nombre
|
name | string | |
|
roleName
|
roleName | string |
InvoiceDetail_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
invoices
|
invoices | array of InvoiceDetails | |
|
paginación
|
pagination | Pagination |
InvoiceDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
número
|
number | string | |
|
refNo
|
refNo | string | |
|
type
|
type | string | |
|
date
|
date | string | |
|
pendiente
|
due | string | |
|
totalPayable
|
totalPayable | double | |
|
Gst
|
gst | double | |
|
pago
|
payment | double | |
|
creditNote
|
creditNote | double | |
|
equilibrar
|
balance | double | |
|
estado
|
status | string | |
|
deudorClientId
|
debtorClientId | integer | |
|
deudorClientCode
|
debtorClientCode | string | |
|
deudorClientName
|
debtorClientName | string | |
|
debtorBrefcode
|
debtorBrefcode | string | |
|
billercode
|
billercode | string | |
|
invoiceLines
|
invoiceLines | array of InvoiceLines | |
|
invoiceJobs
|
invoiceJobs | array of JobInvoice | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string |
InvoiceLines
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
lineNumber
|
lineNumber | integer | |
|
lineDescription
|
lineDescription | string | |
|
lineTotal
|
lineTotal | double |
JobInvoice
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobcode
|
jobcode | string | |
|
nombre
|
name | string | |
|
wip
|
wip | double | |
|
cliente
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
gerente
|
manager | Staff | |
|
división
|
division | DivisionWithDetails | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string | |
|
deudorClient
|
debtorClient | string | |
|
invoiceid
|
invoiceid | integer |
JobPriorityValues
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
jobPriorityId
|
jobPriorityId | integer | |
|
jobPriorityName
|
jobPriorityName | string |
Plantilla de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
templateId
|
templateId | integer | |
|
templateName
|
templateName | string | |
|
description
|
description | string | |
|
estimateType
|
estimateType | string | |
|
turnaround
|
turnaround | integer | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string |
Tipo de trabajo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
jobTypeName
|
jobTypeName | string | |
|
description
|
description | string | |
|
divisionId
|
divisionId | integer | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string |
JobTypeStatus
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
jobTypeId
|
jobTypeId | integer | |
|
statusId
|
statusId | integer | |
|
statusName
|
statusName | string | |
|
categoryId
|
categoryId | integer | |
|
categoryName
|
categoryName | string |
Jobdetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
jobCode
|
jobCode | string | |
|
jobType
|
jobType | string | |
|
nombre
|
name | string | |
|
prioridad
|
priority | string | |
|
dueDate
|
dueDate | string | |
|
estimatedTime
|
estimatedTime | double | |
|
wip
|
wip | double | |
|
cliente
|
client | ClientSummary | |
|
financialYear
|
financialYear | string | |
|
partner
|
partner | Staff | |
|
gerente
|
manager | Staff | |
|
división
|
division | DivisionWithDetails | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string | |
|
deudorClient
|
debtorClient | DebtorClient | |
|
estado
|
status | string | |
|
statusCategory
|
statusCategory | string | |
|
statusOwner
|
statusOwner | UserDetail | |
|
completedTask
|
completedTask | integer | |
|
totalTask
|
totalTask | integer | |
|
tareas
|
tasks | array of TaskDetail | |
|
Cesionarios
|
assignees | array of UserDetail | |
|
team
|
team | TaskDetail | |
|
customFields
|
customFields | array of CustomField |
Jobs_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
jobs
|
jobs | array of Jobdetail | |
|
paginación
|
pagination | Pagination |
Pagination
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
registros_totales
|
total_records | integer | |
|
current_page
|
current_page | integer | |
|
page_Size
|
page_Size | integer | |
|
total_pages
|
total_pages | integer | |
|
next_page
|
next_page | integer | |
|
next_pageurl
|
next_pageurl | string | |
|
prev_page
|
prev_page | integer | |
|
prev_pageurl
|
prev_pageurl | string |
Teléfono
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | string | |
|
número
|
number | string | |
|
favorito
|
favourite | boolean | |
|
feeSynergy
|
feeSynergy | boolean |
Relationship
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
relationshipId
|
relationshipId | string | |
|
type
|
type | string | |
|
Id de entidad
|
entityId | string | |
|
nombre
|
name | string | |
|
Entidad
|
entity | string | |
|
startDate
|
startDate | string | |
|
fecha de finalización
|
endDate | string | |
|
unidades
|
units | integer |
Relationships_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
relationships
|
relationships | array of Relationship | |
|
paginación
|
pagination | Pagination |
Personal
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string | |
|
email
|
string |
TaskDetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | integer | |
|
nombre
|
name | string |
Teams
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
groupId
|
groupId | integer | |
|
teamId
|
teamId | integer | |
|
nombre
|
name | string | |
|
groupMembers
|
groupMembers | array of GroupMember |
UserDetail
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string |
UsersWithDetails
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nombre
|
name | string | |
|
roleName
|
roleName | string | |
|
email
|
|||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
phone
|
phone | Phone | |
|
address
|
address | Address | |
|
creado
|
created | string | |
|
última modificación
|
lastModified | string |
Users_Result
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
users
|
users | array of UsersWithDetails | |
|
paginación
|
pagination | Pagination |