GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Integrations

GET /api/integrations/accounts

hideinactive: boolean
in query

(no description)

200 OK
IntegrationAccount

OK

type
IntegrationAccount
Response Example (200 OK) 
[
  {
    "AccountId": "integer",
    "Name": "string",
    "Description": "string",
    "AccountNumber": "string",
    "AccountType": "string",
    "IsActive": "boolean"
  }
]
Integrations

Get a contact for integrations

GET /api/integrations/contacts/{id}

Get a contact for integrations

id: string
in path

(no description)

200 OK
IntegrationContact

IntegrationContact

Response Example (200 OK) 
{
  "DisplayName": "string",
  "CompanyName": "string",
  "Email": "string",
  "PhoneNumber": "string",
  "ParentIntegrationCustomerId": "string",
  "ContactType": "string",
  "FirstName": "string",
  "LastName": "string",
  "MiddleName": "string",
  "Suffix": "string",
  "Title": "string",
  "IsTaxExempt": "boolean",
  "BillWithParent": "boolean",
  "IntegrationDefaultTaxCodeId": "string",
  "Address": "string"
}
Integrations

Add/update QuickBooks Online Id associated with a contact

POST /api/integrations/contacts/{id}/qbo/mapping/{integrationid}

Add/update QuickBooks Online Id associated with a contact

id: object
in path

(no description)

integrationid: object
in path

(no description)

200 OK

OK

Integrations

Get a credit

GET /api/integrations/credits/{id}

Get a credit

id: string
in path

(no description)

includevoided: boolean
in query

(no description)

200 OK
IntegrationCredit

IntegrationCredit

Response Example (200 OK) 
{
  "CreditDate": "string",
  "AmsContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "CreditNumber": "string",
  "Notes": "string",
  "Total": "number",
  "TotalTax": "number",
  "Email": "string",
  "LineItems": "string",
  "Applications": "string"
}
Integrations

GET /api/integrations/discounts

200 OK
IntegrationDiscount

OK

type
IntegrationDiscount
Response Example (200 OK) 
[
  {
    "DiscountId": "integer",
    "DiscountTypeId": "integer",
    "DiscountTypeName": "string",
    "Name": "string",
    "PromoCode": "string",
    "DiscountPercent": "string",
    "DiscountAmount": "string",
    "StartDate": "string",
    "EndDate": "string"
  }
]
Integrations

GET /api/integrations/feeitems

hideinactive: boolean
in query

(no description)

200 OK
IntegrationFeeItem

OK

type
IntegrationFeeItem
Response Example (200 OK) 
[
  {
    "SaleableItemId": "string",
    "Name": "string",
    "Price": "number",
    "Quantity": "number",
    "Description": "string",
    "IsActive": "boolean"
  }
]
Integrations

GET /api/integrations/gettenantid

200 OK

OK

Integrations

Get an invoice

GET /api/integrations/invoices/{id}

Get an invoice

id: string
in path

(no description)

200 OK
IntegrationInvoice

IntegrationInvoice

Response Example (200 OK) 
{
  "PurchaseId": "integer",
  "InvoiceDate": "string",
  "DueDate": "string",
  "Email": "string",
  "AmsContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "DepositAccountId": "string",
  "InvoiceNumber": "string",
  "CustomerMessage": "string",
  "TotalTax": "number",
  "ShippingAmount": "number",
  "Address": "string",
  "LineItems": "string",
  "Shipping": "string"
}
Integrations

GET /api/integrations/paymentgateways

200 OK
IntegrationPaymentGateway

OK

type
IntegrationPaymentGateway
Response Example (200 OK) 
[
  {
    "PaymentGatewayId": "integer",
    "Name": "string",
    "GatewayAccountId": "string",
    "IsVerified": "boolean"
  }
]
Integrations

Get a payment

GET /api/integrations/payments/{id}

Get a payment

id: string
in path

(no description)

200 OK
IntegrationPayment

IntegrationPayment

Response Example (200 OK) 
{
  "VoidedDate": "string",
  "PaymentDate": "string",
  "ContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "PaymentGatewayId": "string",
  "PaymentTypeId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "PaymentNumber": "string",
  "Notes": "string",
  "Total": "number",
  "Email": "string",
  "Applications": "string"
}
Integrations

GET /api/integrations/paymenttypes

200 OK
IntegrationPaymentType

OK

type
IntegrationPaymentType
Response Example (200 OK) 
[
  {
    "PaymentTypeId": "integer",
    "Name": "string"
  }
]
Integrations

Get a refund

GET /api/integrations/refunds/{id}

Get a refund

id: string
in path

(no description)

200 OK
IntegrationRefund

IntegrationRefund

Response Example (200 OK) 
{
  "TxnDate": "string",
  "AmsContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "AccountsReceivableAccountId": "string",
  "RefundNumber": "string",
  "PaymentNumber": "string",
  "Notes": "string",
  "Total": "number",
  "LineItems": "string"
}
Integrations

GET /api/integrations/taxsets

200 OK
IntegrationTaxSet

OK

type
IntegrationTaxSet
Response Example (200 OK) 
[
  {
    "TaxSetId": "integer",
    "Name": "string",
    "TaxRegionId": "integer",
    "TaxRate": "string"
  }
]
Integrations

GET /api/integrations/transactionclasses

hideinactive: boolean
in query

(no description)

200 OK
IntegrationTransactionClass

OK

type
IntegrationTransactionClass
Response Example (200 OK) 
[
  {
    "ClassId": "integer",
    "Name": "string",
    "FullName": "string",
    "ParentClassId": "string",
    "IsActive": "boolean"
  }
]
Integrations

Get a writeOff

GET /api/integrations/writeoffs/{id}

Get a writeOff

id: string
in path

(no description)

200 OK
IntegrationWriteOff

IntegrationWriteOff

Response Example (200 OK) 
{
  "WriteOffDate": "string",
  "ContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "WriteOffNumber": "string",
  "Notes": "string",
  "Total": "number",
  "TotalTax": "number",
  "Email": "string",
  "LineItems": "string",
  "Applications": "string"
}

Schema Definitions

IHttpActionResult: object

Example
"object"

IntegrationInvoice: object

PurchaseId: integer
InvoiceDate: string
DueDate: string
Email: string
AmsContactId: string
ContactName: string
IntegrationCustomerId: string
DepositAccountId: string
InvoiceNumber: string
CustomerMessage: string
TotalTax: number
ShippingAmount: number
Address: string
LineItems: string
Shipping: string
Example
{
  "PurchaseId": "integer",
  "InvoiceDate": "string",
  "DueDate": "string",
  "Email": "string",
  "AmsContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "DepositAccountId": "string",
  "InvoiceNumber": "string",
  "CustomerMessage": "string",
  "TotalTax": "number",
  "ShippingAmount": "number",
  "Address": "string",
  "LineItems": "string",
  "Shipping": "string"
}

IntegrationPayment: object

VoidedDate: string
PaymentDate: string
ContactId: string
ContactName: string
IntegrationCustomerId: string
PaymentGatewayId: string
PaymentTypeId: string
CurrencyCode: string

A three letter string representing the ISO 4217 code for the currency

DepositAccountId: string
PaymentNumber: string
Notes: string
Total: number
Email: string
Applications: string
Example
{
  "VoidedDate": "string",
  "PaymentDate": "string",
  "ContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "PaymentGatewayId": "string",
  "PaymentTypeId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "PaymentNumber": "string",
  "Notes": "string",
  "Total": "number",
  "Email": "string",
  "Applications": "string"
}

IntegrationContact: object

DisplayName: string
CompanyName: string
Email: string
PhoneNumber: string
ParentIntegrationCustomerId: string
ContactType: string
FirstName: string
LastName: string
MiddleName: string
Suffix: string
Title: string
IsTaxExempt: boolean
BillWithParent: boolean
IntegrationDefaultTaxCodeId: string
Address: string
Example
{
  "DisplayName": "string",
  "CompanyName": "string",
  "Email": "string",
  "PhoneNumber": "string",
  "ParentIntegrationCustomerId": "string",
  "ContactType": "string",
  "FirstName": "string",
  "LastName": "string",
  "MiddleName": "string",
  "Suffix": "string",
  "Title": "string",
  "IsTaxExempt": "boolean",
  "BillWithParent": "boolean",
  "IntegrationDefaultTaxCodeId": "string",
  "Address": "string"
}

String: object

this[]: string
Length: integer
Example
{
  "this[]": "string",
  "Length": "integer"
}

IntegrationFeeItem: object

SaleableItemId: string
Name: string
Price: number
Quantity: number
Description: string
IsActive: boolean
Example
{
  "SaleableItemId": "string",
  "Name": "string",
  "Price": "number",
  "Quantity": "number",
  "Description": "string",
  "IsActive": "boolean"
}

IntegrationCredit: object

CreditDate: string
AmsContactId: string
ContactName: string
IntegrationCustomerId: string
CurrencyCode: string

A three letter string representing the ISO 4217 code for the currency

DepositAccountId: string
CreditNumber: string
Notes: string
Total: number
TotalTax: number
Email: string
LineItems: string
Applications: string
Example
{
  "CreditDate": "string",
  "AmsContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "CreditNumber": "string",
  "Notes": "string",
  "Total": "number",
  "TotalTax": "number",
  "Email": "string",
  "LineItems": "string",
  "Applications": "string"
}

IntegrationTransactionClass: object

ClassId: integer
Name: string
FullName: string
ParentClassId: string
IsActive: boolean
Example
{
  "ClassId": "integer",
  "Name": "string",
  "FullName": "string",
  "ParentClassId": "string",
  "IsActive": "boolean"
}

IntegrationAccount: object

AccountId: integer
Name: string
Description: string
AccountNumber: string
AccountType: string
IsActive: boolean
Example
{
  "AccountId": "integer",
  "Name": "string",
  "Description": "string",
  "AccountNumber": "string",
  "AccountType": "string",
  "IsActive": "boolean"
}

IntegrationRefund: object

TxnDate: string
AmsContactId: string
ContactName: string
IntegrationCustomerId: string
CurrencyCode: string

A three letter string representing the ISO 4217 code for the currency

DepositAccountId: string
AccountsReceivableAccountId: string
RefundNumber: string
PaymentNumber: string
Notes: string
Total: number
LineItems: string
Example
{
  "TxnDate": "string",
  "AmsContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "AccountsReceivableAccountId": "string",
  "RefundNumber": "string",
  "PaymentNumber": "string",
  "Notes": "string",
  "Total": "number",
  "LineItems": "string"
}

IntegrationTaxSet: object

TaxSetId: integer
Name: string
TaxRegionId: integer
TaxRate: string
Example
{
  "TaxSetId": "integer",
  "Name": "string",
  "TaxRegionId": "integer",
  "TaxRate": "string"
}

IntegrationDiscount: object

DiscountId: integer
DiscountTypeId: integer
DiscountTypeName: string
Name: string
PromoCode: string
DiscountPercent: string
DiscountAmount: string
StartDate: string
EndDate: string
Example
{
  "DiscountId": "integer",
  "DiscountTypeId": "integer",
  "DiscountTypeName": "string",
  "Name": "string",
  "PromoCode": "string",
  "DiscountPercent": "string",
  "DiscountAmount": "string",
  "StartDate": "string",
  "EndDate": "string"
}

IntegrationPaymentGateway: object

PaymentGatewayId: integer
Name: string
GatewayAccountId: string
IsVerified: boolean
Example
{
  "PaymentGatewayId": "integer",
  "Name": "string",
  "GatewayAccountId": "string",
  "IsVerified": "boolean"
}

IntegrationPaymentType: object

PaymentTypeId: integer
Name: string
Example
{
  "PaymentTypeId": "integer",
  "Name": "string"
}

IntegrationWriteOff: object

WriteOffDate: string
ContactId: string
ContactName: string
IntegrationCustomerId: string
CurrencyCode: string

A three letter string representing the ISO 4217 code for the currency

DepositAccountId: string
WriteOffNumber: string
Notes: string
Total: number
TotalTax: number
Email: string
LineItems: string
Applications: string
Example
{
  "WriteOffDate": "string",
  "ContactId": "string",
  "ContactName": "string",
  "IntegrationCustomerId": "string",
  "CurrencyCode": "string",
  "DepositAccountId": "string",
  "WriteOffNumber": "string",
  "Notes": "string",
  "Total": "number",
  "TotalTax": "number",
  "Email": "string",
  "LineItems": "string",
  "Applications": "string"
}
Documentation by Spectacle