Download OpenAPI specification:Download
Developer reference for SubscriptionFlow API
SubscriptionFlow provides an HTTP-based API that follows the principles of REST. The HTTP rules followed allow simple HTTP clients like cURL to be used as well. The URLs are resource-oriented, the request format is form-encoded, and the responses are in JSON.
Depending on the type of operation, the endpoints use one of the following HTTP methods:
We recommend using Postman for seamless testing and interaction with our APIs. To make your testing process even smoother, we have prepared a comprehensive collection of API requests in Postman.
Click the link above to import our collection into your Postman workspace. This collection includes pre-configured requests for various API endpoints, allowing you to easily explore and test the functionalities of our API.
SubscriptionFlow uses authentication tokens for authorization of API requests. Follow these steps to obtain an authentication token:
Client Credentials: To get started, follow our [Client Credentials Guide]
(https://support.subscriptionflow.com/hc/en-us/articles/900004667566-How-To-Use-OAuth-Client)
to obtain your unique client_id
and client_secret
from your SubscriptionFlow (SF) instance.
Obtain an Auth Token: Once you have your client_id
and client_secret
,
make a POST request to the OAuth endpoint with these credentials to obtain a bearer token.
Your request should include the following:
client_id
: Your client ID.client_secret
: Your client secret.Grant type
: Use the "client_credentials" grant type to request an access token.Example Request
curl --location --request POST 'http://{site}.subscriptionflow.com/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=your_client_id' \
--data-urlencode 'client_secret=your_client_secret' \
--data-urlencode 'grant_type=client_credentials'
SubscriptionFlow API provides error handling capabilities by using standard HTTP error codes and additional helpful parameters in its error responses. This page provides recommendations on effective error handling and a reference for all custom and standard error codes used by the API.
HTTP status codes are used to indicate success or failure of an API call. The body of the response contains the details of the error in JSON format.
2XX
: The response code in this range implies the API call has succeeded.3XX
: This range is not used currently.4XX
: response codes indicate failure due to wrong input (i.e, client) side.
As the usable list of http codes in the 4xx range is limited we predominantly
use the 400
( BAD REQUEST ) error code for client-side errors.5XX
: response codes indicate API request was valid but failed due to issues on the SubscriptionFlow server.
The 500
( INTERNAL SERVER ERROR ) error code is used for server-side errors.Represents a customer, which can be an individual or organization that subscribes to your products or services. The customer resource associates with subscriptions, card information, and billing addresses. The customer details include their ID, name, contact information, and any custom attributes you'd like to associate with them
Retrieves a list of customers added to your SubscriptionFlow instance. The list contains the necessary customer details such as Name, Balance, and the Customer ID. You can use the Customer ID to retrieve the customer details.
id | any <char> (Id) The unique identifier for the customer. |
parent_id | any <char> (Parent Customer) The identifier of the parent customer if applicable. |
name | any <varchar> (Name) The name of the customer. |
phone_number | any <varchar> (Phone Number) The customer's contact number. |
po_number | any <varchar> (PO Number) The customer's purchase order number. |
legal_entity | any <varchar> (Legal Entity) The legal entity associated with the customer. |
billing_cycle_day | any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts. |
notes | any <text> (Notes) Additional information about the customer. |
image | any <varchar> (Image) The URL of an image for the customer. |
customer_number | any <varchar> (Customer Number) The customer's number or ID. |
terms | any <varchar> (Terms) The terms of payment for the customer. |
created_at | any <timestamp> (Created At) The date and time when the customer was created. |
updated_at | any <timestamp> (Updated At) The date and time when the customer was last updated. |
deleted_at | any <timestamp> (Deleted At) The date and time when the customer was deleted. |
portal_pass | any <varchar> (Portal Pass) The customer's portal password. |
portal_email | any <varchar> (Portal Email) The customer's portal email address. |
portal_is_enabled | any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled. |
last_successful_login | any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal. |
last_failed_login | any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal. |
tax_exempt | any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax. |
certificate_id | any <varchar> (Certificate ID) The customer's tax exemption certificate ID. |
certificate_type | any <varchar> (Certificate Type) The customer's tax exemption certificate type. |
issuing_jurisdiction | any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate. |
entity_use_code | any <varchar> (Entity Use Code) The customer's entity use code. |
description | any <text> (Description) The customer's description. |
tax_company | any <char> (Tax Company) The customer's tax company. |
vat_id | any <varchar> (VAT ID) The customer's VAT ID. |
last_activity | any <varchar> (Last Activity) The date and time when the customer was last active. |
created_by | any <char> (Created By) The user who created the customer. |
updated_by | any <char> (Updated By) The user who last updated the customer. |
assigned_to | any <char> (Assigned To) The user who is assigned to the customer. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the customer. |
auto_charge | any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged. |
balance | any <number> (Outstanding Balance) The customer's outstanding balance. |
unapplied_amount | any <number> (Unapplied Amount) The customer's unapplied amount. |
billing_address_1 | any <text> (Billing Address 1) The customer's billing address line 1. |
billing_address_2 | any <text> (Billing Address 2) The customer's billing address line 2. |
billing_city | any <varchar> (Billing City) The customer's billing address city. |
billing_state | any <varchar> (Billing State) The customer's billing address state. |
billing_county | any <varchar> (Billing County) The customer's billing address county. |
billing_postal_code | any <varchar> (Billing Postal Code) The customer's billing address postal code. |
billing_country | any <varchar> (Billing Country) The customer's billing address country. |
shipping_address_1 | any <text> (Shipping Address 1) The customer's shipping address line 1. |
shipping_address_2 | any <text> (Shipping Address 2) The customer's shipping address line 2. |
shipping_city | any <varchar> (Shipping City) The customer's shipping address city. |
shipping_state | any <varchar> (Shipping State) The customer's shipping address state. |
shipping_county | any <varchar> (Shipping County) The customer's shipping address county. |
shipping_postal_code | any <varchar> (Shipping Postal Code) The customer's shipping address postal code. |
shipping_country | any <varchar> (Shipping Country) The customer's shipping address country. |
data_source | any <char> (Data Source) The data source of the customer. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Creates a customer. You can create a customer and then create subscriptions for the customer when required. When creating a customer, you can pass along the billing address and shipping address of the customer. You can also select the auto charge option to automatically charge the customer for the subscription.
id | any <char> (Id) The unique identifier for the customer. |
parent_id | any <char> (Parent Customer) The identifier of the parent customer if applicable. |
name | any <varchar> (Name) The name of the customer. |
phone_number | any <varchar> (Phone Number) The customer's contact number. |
po_number | any <varchar> (PO Number) The customer's purchase order number. |
legal_entity | any <varchar> (Legal Entity) The legal entity associated with the customer. |
billing_cycle_day | any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts. |
notes | any <text> (Notes) Additional information about the customer. |
image | any <varchar> (Image) The URL of an image for the customer. |
customer_number | any <varchar> (Customer Number) The customer's number or ID. |
terms | any <varchar> (Terms) The terms of payment for the customer. |
created_at | any <timestamp> (Created At) The date and time when the customer was created. |
updated_at | any <timestamp> (Updated At) The date and time when the customer was last updated. |
deleted_at | any <timestamp> (Deleted At) The date and time when the customer was deleted. |
portal_pass | any <varchar> (Portal Pass) The customer's portal password. |
portal_email | any <varchar> (Portal Email) The customer's portal email address. |
portal_is_enabled | any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled. |
last_successful_login | any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal. |
last_failed_login | any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal. |
tax_exempt | any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax. |
certificate_id | any <varchar> (Certificate ID) The customer's tax exemption certificate ID. |
certificate_type | any <varchar> (Certificate Type) The customer's tax exemption certificate type. |
issuing_jurisdiction | any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate. |
entity_use_code | any <varchar> (Entity Use Code) The customer's entity use code. |
description | any <text> (Description) The customer's description. |
tax_company | any <char> (Tax Company) The customer's tax company. |
vat_id | any <varchar> (VAT ID) The customer's VAT ID. |
last_activity | any <varchar> (Last Activity) The date and time when the customer was last active. |
created_by | any <char> (Created By) The user who created the customer. |
updated_by | any <char> (Updated By) The user who last updated the customer. |
assigned_to | any <char> (Assigned To) The user who is assigned to the customer. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the customer. |
auto_charge | any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged. |
balance | any <number> (Outstanding Balance) The customer's outstanding balance. |
unapplied_amount | any <number> (Unapplied Amount) The customer's unapplied amount. |
billing_address_1 | any <text> (Billing Address 1) The customer's billing address line 1. |
billing_address_2 | any <text> (Billing Address 2) The customer's billing address line 2. |
billing_city | any <varchar> (Billing City) The customer's billing address city. |
billing_state | any <varchar> (Billing State) The customer's billing address state. |
billing_county | any <varchar> (Billing County) The customer's billing address county. |
billing_postal_code | any <varchar> (Billing Postal Code) The customer's billing address postal code. |
billing_country | any <varchar> (Billing Country) The customer's billing address country. |
shipping_address_1 | any <text> (Shipping Address 1) The customer's shipping address line 1. |
shipping_address_2 | any <text> (Shipping Address 2) The customer's shipping address line 2. |
shipping_city | any <varchar> (Shipping City) The customer's shipping address city. |
shipping_state | any <varchar> (Shipping State) The customer's shipping address state. |
shipping_county | any <varchar> (Shipping County) The customer's shipping address county. |
shipping_postal_code | any <varchar> (Shipping Postal Code) The customer's shipping address postal code. |
shipping_country | any <varchar> (Shipping Country) The customer's shipping address country. |
data_source | any <char> (Data Source) The data source of the customer. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Retrieves the details of an existing customer. You need to pass the unique customer ID that was returned upon successful customer creation.
customer required | char Customer id |
id | any <char> (Id) The unique identifier for the customer. |
parent_id | any <char> (Parent Customer) The identifier of the parent customer if applicable. |
name | any <varchar> (Name) The name of the customer. |
phone_number | any <varchar> (Phone Number) The customer's contact number. |
po_number | any <varchar> (PO Number) The customer's purchase order number. |
legal_entity | any <varchar> (Legal Entity) The legal entity associated with the customer. |
billing_cycle_day | any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts. |
notes | any <text> (Notes) Additional information about the customer. |
image | any <varchar> (Image) The URL of an image for the customer. |
customer_number | any <varchar> (Customer Number) The customer's number or ID. |
terms | any <varchar> (Terms) The terms of payment for the customer. |
created_at | any <timestamp> (Created At) The date and time when the customer was created. |
updated_at | any <timestamp> (Updated At) The date and time when the customer was last updated. |
deleted_at | any <timestamp> (Deleted At) The date and time when the customer was deleted. |
portal_pass | any <varchar> (Portal Pass) The customer's portal password. |
portal_email | any <varchar> (Portal Email) The customer's portal email address. |
portal_is_enabled | any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled. |
last_successful_login | any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal. |
last_failed_login | any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal. |
tax_exempt | any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax. |
certificate_id | any <varchar> (Certificate ID) The customer's tax exemption certificate ID. |
certificate_type | any <varchar> (Certificate Type) The customer's tax exemption certificate type. |
issuing_jurisdiction | any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate. |
entity_use_code | any <varchar> (Entity Use Code) The customer's entity use code. |
description | any <text> (Description) The customer's description. |
tax_company | any <char> (Tax Company) The customer's tax company. |
vat_id | any <varchar> (VAT ID) The customer's VAT ID. |
last_activity | any <varchar> (Last Activity) The date and time when the customer was last active. |
created_by | any <char> (Created By) The user who created the customer. |
updated_by | any <char> (Updated By) The user who last updated the customer. |
assigned_to | any <char> (Assigned To) The user who is assigned to the customer. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the customer. |
auto_charge | any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged. |
balance | any <number> (Outstanding Balance) The customer's outstanding balance. |
unapplied_amount | any <number> (Unapplied Amount) The customer's unapplied amount. |
billing_address_1 | any <text> (Billing Address 1) The customer's billing address line 1. |
billing_address_2 | any <text> (Billing Address 2) The customer's billing address line 2. |
billing_city | any <varchar> (Billing City) The customer's billing address city. |
billing_state | any <varchar> (Billing State) The customer's billing address state. |
billing_county | any <varchar> (Billing County) The customer's billing address county. |
billing_postal_code | any <varchar> (Billing Postal Code) The customer's billing address postal code. |
billing_country | any <varchar> (Billing Country) The customer's billing address country. |
shipping_address_1 | any <text> (Shipping Address 1) The customer's shipping address line 1. |
shipping_address_2 | any <text> (Shipping Address 2) The customer's shipping address line 2. |
shipping_city | any <varchar> (Shipping City) The customer's shipping address city. |
shipping_state | any <varchar> (Shipping State) The customer's shipping address state. |
shipping_county | any <varchar> (Shipping County) The customer's shipping address county. |
shipping_postal_code | any <varchar> (Shipping Postal Code) The customer's shipping address postal code. |
shipping_country | any <varchar> (Shipping Country) The customer's shipping address country. |
data_source | any <char> (Data Source) The data source of the customer. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the customer's billing address but not the shipping address, the customer's shipping address will be unaltered.
customer required | char Customer id |
id | any <char> (Id) The unique identifier for the customer. |
parent_id | any <char> (Parent Customer) The identifier of the parent customer if applicable. |
name | any <varchar> (Name) The name of the customer. |
phone_number | any <varchar> (Phone Number) The customer's contact number. |
po_number | any <varchar> (PO Number) The customer's purchase order number. |
legal_entity | any <varchar> (Legal Entity) The legal entity associated with the customer. |
billing_cycle_day | any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts. |
notes | any <text> (Notes) Additional information about the customer. |
image | any <varchar> (Image) The URL of an image for the customer. |
customer_number | any <varchar> (Customer Number) The customer's number or ID. |
terms | any <varchar> (Terms) The terms of payment for the customer. |
created_at | any <timestamp> (Created At) The date and time when the customer was created. |
updated_at | any <timestamp> (Updated At) The date and time when the customer was last updated. |
deleted_at | any <timestamp> (Deleted At) The date and time when the customer was deleted. |
portal_pass | any <varchar> (Portal Pass) The customer's portal password. |
portal_email | any <varchar> (Portal Email) The customer's portal email address. |
portal_is_enabled | any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled. |
last_successful_login | any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal. |
last_failed_login | any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal. |
tax_exempt | any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax. |
certificate_id | any <varchar> (Certificate ID) The customer's tax exemption certificate ID. |
certificate_type | any <varchar> (Certificate Type) The customer's tax exemption certificate type. |
issuing_jurisdiction | any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate. |
entity_use_code | any <varchar> (Entity Use Code) The customer's entity use code. |
description | any <text> (Description) The customer's description. |
tax_company | any <char> (Tax Company) The customer's tax company. |
vat_id | any <varchar> (VAT ID) The customer's VAT ID. |
last_activity | any <varchar> (Last Activity) The date and time when the customer was last active. |
created_by | any <char> (Created By) The user who created the customer. |
updated_by | any <char> (Updated By) The user who last updated the customer. |
assigned_to | any <char> (Assigned To) The user who is assigned to the customer. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the customer. |
auto_charge | any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged. |
balance | any <number> (Outstanding Balance) The customer's outstanding balance. |
unapplied_amount | any <number> (Unapplied Amount) The customer's unapplied amount. |
billing_address_1 | any <text> (Billing Address 1) The customer's billing address line 1. |
billing_address_2 | any <text> (Billing Address 2) The customer's billing address line 2. |
billing_city | any <varchar> (Billing City) The customer's billing address city. |
billing_state | any <varchar> (Billing State) The customer's billing address state. |
billing_county | any <varchar> (Billing County) The customer's billing address county. |
billing_postal_code | any <varchar> (Billing Postal Code) The customer's billing address postal code. |
billing_country | any <varchar> (Billing Country) The customer's billing address country. |
shipping_address_1 | any <text> (Shipping Address 1) The customer's shipping address line 1. |
shipping_address_2 | any <text> (Shipping Address 2) The customer's shipping address line 2. |
shipping_city | any <varchar> (Shipping City) The customer's shipping address city. |
shipping_state | any <varchar> (Shipping State) The customer's shipping address state. |
shipping_county | any <varchar> (Shipping County) The customer's shipping address county. |
shipping_postal_code | any <varchar> (Shipping Postal Code) The customer's shipping address postal code. |
shipping_country | any <varchar> (Shipping Country) The customer's shipping address country. |
data_source | any <char> (Data Source) The data source of the customer. |
id | any <char> (Id) The unique identifier for the customer. |
parent_id | any <char> (Parent Customer) The identifier of the parent customer if applicable. |
name | any <varchar> (Name) The name of the customer. |
phone_number | any <varchar> (Phone Number) The customer's contact number. |
po_number | any <varchar> (PO Number) The customer's purchase order number. |
legal_entity | any <varchar> (Legal Entity) The legal entity associated with the customer. |
billing_cycle_day | any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts. |
notes | any <text> (Notes) Additional information about the customer. |
image | any <varchar> (Image) The URL of an image for the customer. |
customer_number | any <varchar> (Customer Number) The customer's number or ID. |
terms | any <varchar> (Terms) The terms of payment for the customer. |
created_at | any <timestamp> (Created At) The date and time when the customer was created. |
updated_at | any <timestamp> (Updated At) The date and time when the customer was last updated. |
deleted_at | any <timestamp> (Deleted At) The date and time when the customer was deleted. |
portal_pass | any <varchar> (Portal Pass) The customer's portal password. |
portal_email | any <varchar> (Portal Email) The customer's portal email address. |
portal_is_enabled | any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled. |
last_successful_login | any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal. |
last_failed_login | any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal. |
tax_exempt | any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax. |
certificate_id | any <varchar> (Certificate ID) The customer's tax exemption certificate ID. |
certificate_type | any <varchar> (Certificate Type) The customer's tax exemption certificate type. |
issuing_jurisdiction | any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate. |
entity_use_code | any <varchar> (Entity Use Code) The customer's entity use code. |
description | any <text> (Description) The customer's description. |
tax_company | any <char> (Tax Company) The customer's tax company. |
vat_id | any <varchar> (VAT ID) The customer's VAT ID. |
last_activity | any <varchar> (Last Activity) The date and time when the customer was last active. |
created_by | any <char> (Created By) The user who created the customer. |
updated_by | any <char> (Updated By) The user who last updated the customer. |
assigned_to | any <char> (Assigned To) The user who is assigned to the customer. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the customer. |
auto_charge | any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged. |
balance | any <number> (Outstanding Balance) The customer's outstanding balance. |
unapplied_amount | any <number> (Unapplied Amount) The customer's unapplied amount. |
billing_address_1 | any <text> (Billing Address 1) The customer's billing address line 1. |
billing_address_2 | any <text> (Billing Address 2) The customer's billing address line 2. |
billing_city | any <varchar> (Billing City) The customer's billing address city. |
billing_state | any <varchar> (Billing State) The customer's billing address state. |
billing_county | any <varchar> (Billing County) The customer's billing address county. |
billing_postal_code | any <varchar> (Billing Postal Code) The customer's billing address postal code. |
billing_country | any <varchar> (Billing Country) The customer's billing address country. |
shipping_address_1 | any <text> (Shipping Address 1) The customer's shipping address line 1. |
shipping_address_2 | any <text> (Shipping Address 2) The customer's shipping address line 2. |
shipping_city | any <varchar> (Shipping City) The customer's shipping address city. |
shipping_state | any <varchar> (Shipping State) The customer's shipping address state. |
shipping_county | any <varchar> (Shipping County) The customer's shipping address county. |
shipping_postal_code | any <varchar> (Shipping Postal Code) The customer's shipping address postal code. |
shipping_country | any <varchar> (Shipping Country) The customer's shipping address country. |
data_source | any <char> (Data Source) The data source of the customer. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Deletes a record and returns deleted record
customer required | char Customer id |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of Customers with all foreign keys
id | any <char> (Id) The unique identifier for the customer. |
parent_id | any <char> (Parent Customer) The identifier of the parent customer if applicable. |
name | any <varchar> (Name) The name of the customer. |
phone_number | any <varchar> (Phone Number) The customer's contact number. |
po_number | any <varchar> (PO Number) The customer's purchase order number. |
legal_entity | any <varchar> (Legal Entity) The legal entity associated with the customer. |
billing_cycle_day | any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts. |
notes | any <text> (Notes) Additional information about the customer. |
image | any <varchar> (Image) The URL of an image for the customer. |
customer_number | any <varchar> (Customer Number) The customer's number or ID. |
terms | any <varchar> (Terms) The terms of payment for the customer. |
created_at | any <timestamp> (Created At) The date and time when the customer was created. |
updated_at | any <timestamp> (Updated At) The date and time when the customer was last updated. |
deleted_at | any <timestamp> (Deleted At) The date and time when the customer was deleted. |
portal_pass | any <varchar> (Portal Pass) The customer's portal password. |
portal_email | any <varchar> (Portal Email) The customer's portal email address. |
portal_is_enabled | any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled. |
last_successful_login | any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal. |
last_failed_login | any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal. |
tax_exempt | any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax. |
certificate_id | any <varchar> (Certificate ID) The customer's tax exemption certificate ID. |
certificate_type | any <varchar> (Certificate Type) The customer's tax exemption certificate type. |
issuing_jurisdiction | any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate. |
entity_use_code | any <varchar> (Entity Use Code) The customer's entity use code. |
description | any <text> (Description) The customer's description. |
tax_company | any <char> (Tax Company) The customer's tax company. |
vat_id | any <varchar> (VAT ID) The customer's VAT ID. |
last_activity | any <varchar> (Last Activity) The date and time when the customer was last active. |
created_by | any <char> (Created By) The user who created the customer. |
updated_by | any <char> (Updated By) The user who last updated the customer. |
assigned_to | any <char> (Assigned To) The user who is assigned to the customer. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the customer. |
auto_charge | any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged. |
balance | any <number> (Outstanding Balance) The customer's outstanding balance. |
unapplied_amount | any <number> (Unapplied Amount) The customer's unapplied amount. |
billing_address_1 | any <text> (Billing Address 1) The customer's billing address line 1. |
billing_address_2 | any <text> (Billing Address 2) The customer's billing address line 2. |
billing_city | any <varchar> (Billing City) The customer's billing address city. |
billing_state | any <varchar> (Billing State) The customer's billing address state. |
billing_county | any <varchar> (Billing County) The customer's billing address county. |
billing_postal_code | any <varchar> (Billing Postal Code) The customer's billing address postal code. |
billing_country | any <varchar> (Billing Country) The customer's billing address country. |
shipping_address_1 | any <text> (Shipping Address 1) The customer's shipping address line 1. |
shipping_address_2 | any <text> (Shipping Address 2) The customer's shipping address line 2. |
shipping_city | any <varchar> (Shipping City) The customer's shipping address city. |
shipping_state | any <varchar> (Shipping State) The customer's shipping address state. |
shipping_county | any <varchar> (Shipping County) The customer's shipping address county. |
shipping_postal_code | any <varchar> (Shipping Postal Code) The customer's shipping address postal code. |
shipping_country | any <varchar> (Shipping Country) The customer's shipping address country. |
data_source | any <char> (Data Source) The data source of the customer. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of Customers with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <char> (Id) The unique identifier for the customer. |
parent_id | any <char> (Parent Customer) The identifier of the parent customer if applicable. |
name | any <varchar> (Name) The name of the customer. |
phone_number | any <varchar> (Phone Number) The customer's contact number. |
po_number | any <varchar> (PO Number) The customer's purchase order number. |
legal_entity | any <varchar> (Legal Entity) The legal entity associated with the customer. |
billing_cycle_day | any <varchar> (Billing Cycle Day) The day of the month when the customer's billing cycle starts. |
notes | any <text> (Notes) Additional information about the customer. |
image | any <varchar> (Image) The URL of an image for the customer. |
customer_number | any <varchar> (Customer Number) The customer's number or ID. |
terms | any <varchar> (Terms) The terms of payment for the customer. |
created_at | any <timestamp> (Created At) The date and time when the customer was created. |
updated_at | any <timestamp> (Updated At) The date and time when the customer was last updated. |
deleted_at | any <timestamp> (Deleted At) The date and time when the customer was deleted. |
portal_pass | any <varchar> (Portal Pass) The customer's portal password. |
portal_email | any <varchar> (Portal Email) The customer's portal email address. |
portal_is_enabled | any <tinyint> (Portal Is Enabled) Indicates whether the customer's portal is enabled. |
last_successful_login | any <datetime> (Last Successful Login) The date and time when the customer last logged in to the portal. |
last_failed_login | any <datetime> (Last Failed Login) The date and time when the customer last failed to log in to the portal. |
tax_exempt | any <tinyint> (Tax Exempt) Indicates whether the customer is exempt from tax. |
certificate_id | any <varchar> (Certificate ID) The customer's tax exemption certificate ID. |
certificate_type | any <varchar> (Certificate Type) The customer's tax exemption certificate type. |
issuing_jurisdiction | any <varchar> (Issuing Jurisdiction) The jurisdiction that issued the customer's tax exemption certificate. |
entity_use_code | any <varchar> (Entity Use Code) The customer's entity use code. |
description | any <text> (Description) The customer's description. |
tax_company | any <char> (Tax Company) The customer's tax company. |
vat_id | any <varchar> (VAT ID) The customer's VAT ID. |
last_activity | any <varchar> (Last Activity) The date and time when the customer was last active. |
created_by | any <char> (Created By) The user who created the customer. |
updated_by | any <char> (Updated By) The user who last updated the customer. |
assigned_to | any <char> (Assigned To) The user who is assigned to the customer. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the customer. |
auto_charge | any <tinyint> (Auto Charge) Indicates whether the customer is automatically charged. |
balance | any <number> (Outstanding Balance) The customer's outstanding balance. |
unapplied_amount | any <number> (Unapplied Amount) The customer's unapplied amount. |
billing_address_1 | any <text> (Billing Address 1) The customer's billing address line 1. |
billing_address_2 | any <text> (Billing Address 2) The customer's billing address line 2. |
billing_city | any <varchar> (Billing City) The customer's billing address city. |
billing_state | any <varchar> (Billing State) The customer's billing address state. |
billing_county | any <varchar> (Billing County) The customer's billing address county. |
billing_postal_code | any <varchar> (Billing Postal Code) The customer's billing address postal code. |
billing_country | any <varchar> (Billing Country) The customer's billing address country. |
shipping_address_1 | any <text> (Shipping Address 1) The customer's shipping address line 1. |
shipping_address_2 | any <text> (Shipping Address 2) The customer's shipping address line 2. |
shipping_city | any <varchar> (Shipping City) The customer's shipping address city. |
shipping_state | any <varchar> (Shipping State) The customer's shipping address state. |
shipping_county | any <varchar> (Shipping County) The customer's shipping address county. |
shipping_postal_code | any <varchar> (Shipping Postal Code) The customer's shipping address postal code. |
shipping_country | any <varchar> (Shipping Country) The customer's shipping address country. |
data_source | any <char> (Data Source) The data source of the customer. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns filtered Customer data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns deleted Customers data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "parent_id": "__test__cs5VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "phone_number": "+1 (123) 456-7890",
- "po_number": "PO12345",
- "legal_entity": "Acme Corp Legal Entity",
- "billing_cycle_day": "15",
- "notes": "Important customer with special requirements.",
- "customer_number": "12345",
- "terms": "Net 30",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "deleted_at": "2020-01-01T00:00:00Z",
- "portal_pass": "123456",
- "portal_is_enabled": 1,
- "last_successful_login": "2020-01-01T00:00:00Z",
- "last_failed_login": "2020-01-01T00:00:00Z",
- "tax_exempt": 0,
- "certificate_id": "12345",
- "certificate_type": "resale",
- "issuing_jurisdiction": "California",
- "entity_use_code": "A",
- "description": "Important customer with special requirements.",
- "tax_company": "__test__cs3VnHhSBWl7eY2bl",
- "vat_id": "12345",
- "last_activity": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "auto_charge": 0,
- "balance": 0,
- "unapplied_amount": 0,
- "billing_address_1": "123 Main St.",
- "billing_address_2": "Suite 100",
- "billing_city": "San Francisco",
- "billing_state": "CA",
- "billing_county": "San Francisco",
- "billing_postal_code": "94105",
- "billing_country": "US",
- "shipping_address_1": "123 Main St.",
- "shipping_address_2": "Suite 100",
- "shipping_city": "San Francisco",
- "shipping_state": "CA",
- "shipping_county": "San Francisco",
- "shipping_postal_code": "94105",
- "shipping_country": "US",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of Customers
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns EmailAddress data
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns EmailAddress data
email-address required | char EmailAddress id |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns updated EmailAddress data
email-address required | char EmailAddress id |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns list of Customers with all foreign keys
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns list of Customers with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
any <varchar> (Email) | |
primary | any <tinyint> (Primary) primary |
invalid | any <tinyint> (Invalid) invalid |
opt_out | any <tinyint> (Opt Out) opt_out |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
Returns filtered EmailAddress data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "email": "",
- "primary": "",
- "invalid": "",
- "opt_out": ""
}
A contact is a person associated with a customer. The contact details include the contact ID, name, email, phone, and status.
Retrieves a list of contacts added to your SubscriptionFlow instance. The list contains the necessary contact details such as Name, Balance, and the Contact ID. You can use the Contact ID to retrieve the contact details.
id | any <char> (Id) The unique identifier for the contact. |
customer_id | any <char> (Customer) The identifier of the customer. |
salutation | any <varchar> (Salutation) The salutation of the contact. |
first_name | any <varchar> (First Name) The first name of the contact. |
last_name | any <varchar> (Last Name) The last name of the contact. |
name | any <varchar> (Name) The name of the contact. |
any <varchar> (Email) The email address of the contact. | |
work_phone | any <varchar> (Work Phone) The work phone number of the contact. |
personal_phone | any <varchar> (Personal Phone) The personal phone number of the contact. |
home_phone | any <varchar> (Home Phone) The home phone number of the contact. |
other_phone | any <varchar> (Other Phone) The other phone number of the contact. |
fax | any <varchar> (Fax) The fax number of the contact. |
description | any <text> (Description) The description of the contact. |
is_primary | any <tinyint> (Is Primary) The primary contact of the customer. |
created_at | any <timestamp> (Created At) The date and time when the contact was created. |
updated_at | any <timestamp> (Updated At) The date and time when the contact was last updated. |
created_by | any <char> (Created By) The user who created the contact. |
updated_by | any <char> (Updated By) The user who last updated the contact. |
assigned_to | any <char> (Assigned To) The user who the contact is assigned to. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group who the contact is assigned to. |
billing_address_1 | any <text> (Billing Address 1) The billing address of the contact. |
billing_address_2 | any <text> (Billing Address 2) The billing address of the contact. |
billing_city | any <varchar> (Billing City) The billing city of the contact. |
billing_state | any <varchar> (Billing State) The billing state of the contact. |
billing_county | any <varchar> (Billing County) The billing county of the contact. |
billing_postal_code | any <varchar> (Billing Postal Code) The billing postal code of the contact. |
billing_country | any <varchar> (Billing Country) The billing country of the contact. |
shipping_address_1 | any <text> (Shipping Address 1) The shipping address of the contact. |
shipping_address_2 | any <text> (Shipping Address 2) The shipping address of the contact. |
shipping_city | any <contacts> (Shipping City) The shipping city of the contact. |
shipping_state | any <varchar> (Shipping State) The shipping state of the contact. |
shipping_county | any <varchar> (Shipping County) The shipping county of the contact. |
shipping_postal_code | any <contacts> (Shipping Postal Code) The shipping postal code of the contact. |
shipping_country | any <varchar> (Shipping Country) The shipping country of the contact. |
data_source | any <char> (Data Source) The data source of the contact. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Creates a contact. You can create a contact and then create subscriptions for the contact when required. When creating a contact, you can pass along the billing address and shipping address of the contact.
id | any <char> (Id) The unique identifier for the contact. |
customer_id | any <char> (Customer) The identifier of the customer. |
salutation | any <varchar> (Salutation) The salutation of the contact. |
first_name | any <varchar> (First Name) The first name of the contact. |
last_name | any <varchar> (Last Name) The last name of the contact. |
name | any <varchar> (Name) The name of the contact. |
any <varchar> (Email) The email address of the contact. | |
work_phone | any <varchar> (Work Phone) The work phone number of the contact. |
personal_phone | any <varchar> (Personal Phone) The personal phone number of the contact. |
home_phone | any <varchar> (Home Phone) The home phone number of the contact. |
other_phone | any <varchar> (Other Phone) The other phone number of the contact. |
fax | any <varchar> (Fax) The fax number of the contact. |
description | any <text> (Description) The description of the contact. |
is_primary | any <tinyint> (Is Primary) The primary contact of the customer. |
created_at | any <timestamp> (Created At) The date and time when the contact was created. |
updated_at | any <timestamp> (Updated At) The date and time when the contact was last updated. |
created_by | any <char> (Created By) The user who created the contact. |
updated_by | any <char> (Updated By) The user who last updated the contact. |
assigned_to | any <char> (Assigned To) The user who the contact is assigned to. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group who the contact is assigned to. |
billing_address_1 | any <text> (Billing Address 1) The billing address of the contact. |
billing_address_2 | any <text> (Billing Address 2) The billing address of the contact. |
billing_city | any <varchar> (Billing City) The billing city of the contact. |
billing_state | any <varchar> (Billing State) The billing state of the contact. |
billing_county | any <varchar> (Billing County) The billing county of the contact. |
billing_postal_code | any <varchar> (Billing Postal Code) The billing postal code of the contact. |
billing_country | any <varchar> (Billing Country) The billing country of the contact. |
shipping_address_1 | any <text> (Shipping Address 1) The shipping address of the contact. |
shipping_address_2 | any <text> (Shipping Address 2) The shipping address of the contact. |
shipping_city | any <contacts> (Shipping City) The shipping city of the contact. |
shipping_state | any <varchar> (Shipping State) The shipping state of the contact. |
shipping_county | any <varchar> (Shipping County) The shipping county of the contact. |
shipping_postal_code | any <contacts> (Shipping Postal Code) The shipping postal code of the contact. |
shipping_country | any <varchar> (Shipping Country) The shipping country of the contact. |
data_source | any <char> (Data Source) The data source of the contact. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Retrieves the details of an existing contact. You need to pass the unique contact ID that was returned upon successful contact creation.
contact required | char Contact id |
id | any <char> (Id) The unique identifier for the contact. |
customer_id | any <char> (Customer) The identifier of the customer. |
salutation | any <varchar> (Salutation) The salutation of the contact. |
first_name | any <varchar> (First Name) The first name of the contact. |
last_name | any <varchar> (Last Name) The last name of the contact. |
name | any <varchar> (Name) The name of the contact. |
any <varchar> (Email) The email address of the contact. | |
work_phone | any <varchar> (Work Phone) The work phone number of the contact. |
personal_phone | any <varchar> (Personal Phone) The personal phone number of the contact. |
home_phone | any <varchar> (Home Phone) The home phone number of the contact. |
other_phone | any <varchar> (Other Phone) The other phone number of the contact. |
fax | any <varchar> (Fax) The fax number of the contact. |
description | any <text> (Description) The description of the contact. |
is_primary | any <tinyint> (Is Primary) The primary contact of the customer. |
created_at | any <timestamp> (Created At) The date and time when the contact was created. |
updated_at | any <timestamp> (Updated At) The date and time when the contact was last updated. |
created_by | any <char> (Created By) The user who created the contact. |
updated_by | any <char> (Updated By) The user who last updated the contact. |
assigned_to | any <char> (Assigned To) The user who the contact is assigned to. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group who the contact is assigned to. |
billing_address_1 | any <text> (Billing Address 1) The billing address of the contact. |
billing_address_2 | any <text> (Billing Address 2) The billing address of the contact. |
billing_city | any <varchar> (Billing City) The billing city of the contact. |
billing_state | any <varchar> (Billing State) The billing state of the contact. |
billing_county | any <varchar> (Billing County) The billing county of the contact. |
billing_postal_code | any <varchar> (Billing Postal Code) The billing postal code of the contact. |
billing_country | any <varchar> (Billing Country) The billing country of the contact. |
shipping_address_1 | any <text> (Shipping Address 1) The shipping address of the contact. |
shipping_address_2 | any <text> (Shipping Address 2) The shipping address of the contact. |
shipping_city | any <contacts> (Shipping City) The shipping city of the contact. |
shipping_state | any <varchar> (Shipping State) The shipping state of the contact. |
shipping_county | any <varchar> (Shipping County) The shipping county of the contact. |
shipping_postal_code | any <contacts> (Shipping Postal Code) The shipping postal code of the contact. |
shipping_country | any <varchar> (Shipping Country) The shipping country of the contact. |
data_source | any <char> (Data Source) The data source of the contact. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the contact's billing address but not the shipping address, the contact's shipping address will be unaltered.
contact required | char Contact id |
id | any <char> (Id) The unique identifier for the contact. |
customer_id | any <char> (Customer) The identifier of the customer. |
salutation | any <varchar> (Salutation) The salutation of the contact. |
first_name | any <varchar> (First Name) The first name of the contact. |
last_name | any <varchar> (Last Name) The last name of the contact. |
name | any <varchar> (Name) The name of the contact. |
any <varchar> (Email) The email address of the contact. | |
work_phone | any <varchar> (Work Phone) The work phone number of the contact. |
personal_phone | any <varchar> (Personal Phone) The personal phone number of the contact. |
home_phone | any <varchar> (Home Phone) The home phone number of the contact. |
other_phone | any <varchar> (Other Phone) The other phone number of the contact. |
fax | any <varchar> (Fax) The fax number of the contact. |
description | any <text> (Description) The description of the contact. |
is_primary | any <tinyint> (Is Primary) The primary contact of the customer. |
created_at | any <timestamp> (Created At) The date and time when the contact was created. |
updated_at | any <timestamp> (Updated At) The date and time when the contact was last updated. |
created_by | any <char> (Created By) The user who created the contact. |
updated_by | any <char> (Updated By) The user who last updated the contact. |
assigned_to | any <char> (Assigned To) The user who the contact is assigned to. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group who the contact is assigned to. |
billing_address_1 | any <text> (Billing Address 1) The billing address of the contact. |
billing_address_2 | any <text> (Billing Address 2) The billing address of the contact. |
billing_city | any <varchar> (Billing City) The billing city of the contact. |
billing_state | any <varchar> (Billing State) The billing state of the contact. |
billing_county | any <varchar> (Billing County) The billing county of the contact. |
billing_postal_code | any <varchar> (Billing Postal Code) The billing postal code of the contact. |
billing_country | any <varchar> (Billing Country) The billing country of the contact. |
shipping_address_1 | any <text> (Shipping Address 1) The shipping address of the contact. |
shipping_address_2 | any <text> (Shipping Address 2) The shipping address of the contact. |
shipping_city | any <contacts> (Shipping City) The shipping city of the contact. |
shipping_state | any <varchar> (Shipping State) The shipping state of the contact. |
shipping_county | any <varchar> (Shipping County) The shipping county of the contact. |
shipping_postal_code | any <contacts> (Shipping Postal Code) The shipping postal code of the contact. |
shipping_country | any <varchar> (Shipping Country) The shipping country of the contact. |
data_source | any <char> (Data Source) The data source of the contact. |
id | any <char> (Id) The unique identifier for the contact. |
customer_id | any <char> (Customer) The identifier of the customer. |
salutation | any <varchar> (Salutation) The salutation of the contact. |
first_name | any <varchar> (First Name) The first name of the contact. |
last_name | any <varchar> (Last Name) The last name of the contact. |
name | any <varchar> (Name) The name of the contact. |
any <varchar> (Email) The email address of the contact. | |
work_phone | any <varchar> (Work Phone) The work phone number of the contact. |
personal_phone | any <varchar> (Personal Phone) The personal phone number of the contact. |
home_phone | any <varchar> (Home Phone) The home phone number of the contact. |
other_phone | any <varchar> (Other Phone) The other phone number of the contact. |
fax | any <varchar> (Fax) The fax number of the contact. |
description | any <text> (Description) The description of the contact. |
is_primary | any <tinyint> (Is Primary) The primary contact of the customer. |
created_at | any <timestamp> (Created At) The date and time when the contact was created. |
updated_at | any <timestamp> (Updated At) The date and time when the contact was last updated. |
created_by | any <char> (Created By) The user who created the contact. |
updated_by | any <char> (Updated By) The user who last updated the contact. |
assigned_to | any <char> (Assigned To) The user who the contact is assigned to. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group who the contact is assigned to. |
billing_address_1 | any <text> (Billing Address 1) The billing address of the contact. |
billing_address_2 | any <text> (Billing Address 2) The billing address of the contact. |
billing_city | any <varchar> (Billing City) The billing city of the contact. |
billing_state | any <varchar> (Billing State) The billing state of the contact. |
billing_county | any <varchar> (Billing County) The billing county of the contact. |
billing_postal_code | any <varchar> (Billing Postal Code) The billing postal code of the contact. |
billing_country | any <varchar> (Billing Country) The billing country of the contact. |
shipping_address_1 | any <text> (Shipping Address 1) The shipping address of the contact. |
shipping_address_2 | any <text> (Shipping Address 2) The shipping address of the contact. |
shipping_city | any <contacts> (Shipping City) The shipping city of the contact. |
shipping_state | any <varchar> (Shipping State) The shipping state of the contact. |
shipping_county | any <varchar> (Shipping County) The shipping county of the contact. |
shipping_postal_code | any <contacts> (Shipping Postal Code) The shipping postal code of the contact. |
shipping_country | any <varchar> (Shipping Country) The shipping country of the contact. |
data_source | any <char> (Data Source) The data source of the contact. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Deletes a record and returns deleted record
contact required | char Contact id |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns list of Contacts with all foreign keys
id | any <char> (Id) The unique identifier for the contact. |
customer_id | any <char> (Customer) The identifier of the customer. |
salutation | any <varchar> (Salutation) The salutation of the contact. |
first_name | any <varchar> (First Name) The first name of the contact. |
last_name | any <varchar> (Last Name) The last name of the contact. |
name | any <varchar> (Name) The name of the contact. |
any <varchar> (Email) The email address of the contact. | |
work_phone | any <varchar> (Work Phone) The work phone number of the contact. |
personal_phone | any <varchar> (Personal Phone) The personal phone number of the contact. |
home_phone | any <varchar> (Home Phone) The home phone number of the contact. |
other_phone | any <varchar> (Other Phone) The other phone number of the contact. |
fax | any <varchar> (Fax) The fax number of the contact. |
description | any <text> (Description) The description of the contact. |
is_primary | any <tinyint> (Is Primary) The primary contact of the customer. |
created_at | any <timestamp> (Created At) The date and time when the contact was created. |
updated_at | any <timestamp> (Updated At) The date and time when the contact was last updated. |
created_by | any <char> (Created By) The user who created the contact. |
updated_by | any <char> (Updated By) The user who last updated the contact. |
assigned_to | any <char> (Assigned To) The user who the contact is assigned to. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group who the contact is assigned to. |
billing_address_1 | any <text> (Billing Address 1) The billing address of the contact. |
billing_address_2 | any <text> (Billing Address 2) The billing address of the contact. |
billing_city | any <varchar> (Billing City) The billing city of the contact. |
billing_state | any <varchar> (Billing State) The billing state of the contact. |
billing_county | any <varchar> (Billing County) The billing county of the contact. |
billing_postal_code | any <varchar> (Billing Postal Code) The billing postal code of the contact. |
billing_country | any <varchar> (Billing Country) The billing country of the contact. |
shipping_address_1 | any <text> (Shipping Address 1) The shipping address of the contact. |
shipping_address_2 | any <text> (Shipping Address 2) The shipping address of the contact. |
shipping_city | any <contacts> (Shipping City) The shipping city of the contact. |
shipping_state | any <varchar> (Shipping State) The shipping state of the contact. |
shipping_county | any <varchar> (Shipping County) The shipping county of the contact. |
shipping_postal_code | any <contacts> (Shipping Postal Code) The shipping postal code of the contact. |
shipping_country | any <varchar> (Shipping Country) The shipping country of the contact. |
data_source | any <char> (Data Source) The data source of the contact. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns list of Contacts with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <char> (Id) The unique identifier for the contact. |
customer_id | any <char> (Customer) The identifier of the customer. |
salutation | any <varchar> (Salutation) The salutation of the contact. |
first_name | any <varchar> (First Name) The first name of the contact. |
last_name | any <varchar> (Last Name) The last name of the contact. |
name | any <varchar> (Name) The name of the contact. |
any <varchar> (Email) The email address of the contact. | |
work_phone | any <varchar> (Work Phone) The work phone number of the contact. |
personal_phone | any <varchar> (Personal Phone) The personal phone number of the contact. |
home_phone | any <varchar> (Home Phone) The home phone number of the contact. |
other_phone | any <varchar> (Other Phone) The other phone number of the contact. |
fax | any <varchar> (Fax) The fax number of the contact. |
description | any <text> (Description) The description of the contact. |
is_primary | any <tinyint> (Is Primary) The primary contact of the customer. |
created_at | any <timestamp> (Created At) The date and time when the contact was created. |
updated_at | any <timestamp> (Updated At) The date and time when the contact was last updated. |
created_by | any <char> (Created By) The user who created the contact. |
updated_by | any <char> (Updated By) The user who last updated the contact. |
assigned_to | any <char> (Assigned To) The user who the contact is assigned to. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group who the contact is assigned to. |
billing_address_1 | any <text> (Billing Address 1) The billing address of the contact. |
billing_address_2 | any <text> (Billing Address 2) The billing address of the contact. |
billing_city | any <varchar> (Billing City) The billing city of the contact. |
billing_state | any <varchar> (Billing State) The billing state of the contact. |
billing_county | any <varchar> (Billing County) The billing county of the contact. |
billing_postal_code | any <varchar> (Billing Postal Code) The billing postal code of the contact. |
billing_country | any <varchar> (Billing Country) The billing country of the contact. |
shipping_address_1 | any <text> (Shipping Address 1) The shipping address of the contact. |
shipping_address_2 | any <text> (Shipping Address 2) The shipping address of the contact. |
shipping_city | any <contacts> (Shipping City) The shipping city of the contact. |
shipping_state | any <varchar> (Shipping State) The shipping state of the contact. |
shipping_county | any <varchar> (Shipping County) The shipping county of the contact. |
shipping_postal_code | any <contacts> (Shipping Postal Code) The shipping postal code of the contact. |
shipping_country | any <varchar> (Shipping Country) The shipping country of the contact. |
data_source | any <char> (Data Source) The data source of the contact. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns filtered Contact data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns deleted Contacts data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "customer_id": "__test__cs5VnHhSBWl7eY2bl",
- "salutation": "Mr",
- "first_name": "John",
- "last_name": "Doe",
- "name": "John Doe",
- "work_phone": "+1 (123) 456-7890",
- "personal_phone": "+1 (123) 456-7890",
- "home_phone": "+1 (123) 456-7890",
- "other_phone": "+1 (123) 456-7890",
- "fax": "+1 (123) 456-7890",
- "description": "Important contact with special requirements.",
- "is_primary": "1",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__cs3VnHhSBWl7eY2bl",
- "billing_address_1": "",
- "billing_address_2": "",
- "billing_city": "",
- "billing_state": "",
- "billing_county": "",
- "billing_postal_code": "",
- "billing_country": "",
- "shipping_address_1": "",
- "shipping_address_2": "",
- "shipping_city": "",
- "shipping_state": "",
- "shipping_county": "",
- "shipping_postal_code": "",
- "shipping_country": "",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
A SubscriptionFlow subscription connects a customer record to products/services. It describes what the customer has signed up for and how often they're charged for it. The essential components of a subscription are:
Returns a list of subscriptions meeting all the conditions specified in the filter parameters below.
id | any <varchar> (Id) A unique and immutable identifier for the subscription. |
customer_id | any <char> (Customer) Identifier of the customer with whom this subscription is associated. |
items | any <array> (Items) Identifier of the plan and product with whom this subscription is associated. |
name | any <varchar> (Name) The name associated with this subscription. |
type | any <varchar> (Type) The type or category of the subscription. Possible values are
|
termed_start_date | any <date> (Term Start Date) The date when the subscription's term starts. |
termed_initial_period | any <int> (Term Initial Period) The initial period of the subscription term. |
termed_initial_period_type | any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are
|
renewal_type | any <varchar> (Renewal Type) The type of renewal for the subscription. |
renewal_period | any <int> (Renewal Period) The renewal period duration. |
renewal_period_type | any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are
|
is_auto_renew | any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no). |
trigger_dates | any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription. |
invoice_separate | any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no). |
total_amount | any <double> (Total Amount) The total amount associated with the subscription's plan-items.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
payment_status | any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid). |
created_at | any <timestamp> (Created At) The date and time when the subscription was created. |
suspended_at | any <timestamp> (Suspended At) The date and time when the subscription was suspended. |
cancelled_at | any <timestamp> (Cancelled At) The date and time when the subscription was cancelled. |
billing_end_date | any <date> (Billing End Date) The date when billing for the subscription ends. |
updated_at | any <timestamp> (Updated At) The date and time when the subscription was last updated. |
created_by | any <char> (Created By) The identifier of the user who created the subscription. |
updated_by | any <char> (Updated By) The identifier of the user who last updated the subscription. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the subscription is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the subscription is assigned. |
data_source | any <char> (Data Source) The source of data for the subscription. |
trial_period | any <int> (Trial Period) The duration of the trial period. |
trial_period_unit | any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are
|
is_gift | any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no). |
recipient_id | any <char> (Gift Recipient) The identifier of the recipient of the gift subscription. |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Creates a new subscription for an existing customer in SubscriptionFlow.
id | any <varchar> (Id) A unique and immutable identifier for the subscription. |
customer_id | any <char> (Customer) Identifier of the customer with whom this subscription is associated. |
items | any <array> (Items) Identifier of the plan and product with whom this subscription is associated. |
name | any <varchar> (Name) The name associated with this subscription. |
type | any <varchar> (Type) The type or category of the subscription. Possible values are
|
termed_start_date | any <date> (Term Start Date) The date when the subscription's term starts. |
termed_initial_period | any <int> (Term Initial Period) The initial period of the subscription term. |
termed_initial_period_type | any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are
|
renewal_type | any <varchar> (Renewal Type) The type of renewal for the subscription. |
renewal_period | any <int> (Renewal Period) The renewal period duration. |
renewal_period_type | any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are
|
is_auto_renew | any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no). |
trigger_dates | any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription. |
invoice_separate | any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no). |
total_amount | any <double> (Total Amount) The total amount associated with the subscription's plan-items.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
payment_status | any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid). |
created_at | any <timestamp> (Created At) The date and time when the subscription was created. |
suspended_at | any <timestamp> (Suspended At) The date and time when the subscription was suspended. |
cancelled_at | any <timestamp> (Cancelled At) The date and time when the subscription was cancelled. |
billing_end_date | any <date> (Billing End Date) The date when billing for the subscription ends. |
updated_at | any <timestamp> (Updated At) The date and time when the subscription was last updated. |
created_by | any <char> (Created By) The identifier of the user who created the subscription. |
updated_by | any <char> (Updated By) The identifier of the user who last updated the subscription. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the subscription is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the subscription is assigned. |
data_source | any <char> (Data Source) The source of data for the subscription. |
trial_period | any <int> (Trial Period) The duration of the trial period. |
trial_period_unit | any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are
|
is_gift | any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no). |
recipient_id | any <char> (Gift Recipient) The identifier of the recipient of the gift subscription. |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Retrieves a subscription.
subscription required | char Subscription id |
id | any <varchar> (Id) A unique and immutable identifier for the subscription. |
customer_id | any <char> (Customer) Identifier of the customer with whom this subscription is associated. |
items | any <array> (Items) Identifier of the plan and product with whom this subscription is associated. |
name | any <varchar> (Name) The name associated with this subscription. |
type | any <varchar> (Type) The type or category of the subscription. Possible values are
|
termed_start_date | any <date> (Term Start Date) The date when the subscription's term starts. |
termed_initial_period | any <int> (Term Initial Period) The initial period of the subscription term. |
termed_initial_period_type | any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are
|
renewal_type | any <varchar> (Renewal Type) The type of renewal for the subscription. |
renewal_period | any <int> (Renewal Period) The renewal period duration. |
renewal_period_type | any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are
|
is_auto_renew | any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no). |
trigger_dates | any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription. |
invoice_separate | any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no). |
total_amount | any <double> (Total Amount) The total amount associated with the subscription's plan-items.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
payment_status | any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid). |
created_at | any <timestamp> (Created At) The date and time when the subscription was created. |
suspended_at | any <timestamp> (Suspended At) The date and time when the subscription was suspended. |
cancelled_at | any <timestamp> (Cancelled At) The date and time when the subscription was cancelled. |
billing_end_date | any <date> (Billing End Date) The date when billing for the subscription ends. |
updated_at | any <timestamp> (Updated At) The date and time when the subscription was last updated. |
created_by | any <char> (Created By) The identifier of the user who created the subscription. |
updated_by | any <char> (Updated By) The identifier of the user who last updated the subscription. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the subscription is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the subscription is assigned. |
data_source | any <char> (Data Source) The source of data for the subscription. |
trial_period | any <int> (Trial Period) The duration of the trial period. |
trial_period_unit | any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are
|
is_gift | any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no). |
recipient_id | any <char> (Gift Recipient) The identifier of the recipient of the gift subscription. |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns updated Subscription data
subscription required | char Subscription id |
id | any <varchar> (Id) A unique and immutable identifier for the subscription. |
customer_id | any <char> (Customer) Identifier of the customer with whom this subscription is associated. |
items | any <array> (Items) Identifier of the plan and product with whom this subscription is associated. |
name | any <varchar> (Name) The name associated with this subscription. |
type | any <varchar> (Type) The type or category of the subscription. Possible values are
|
termed_start_date | any <date> (Term Start Date) The date when the subscription's term starts. |
termed_initial_period | any <int> (Term Initial Period) The initial period of the subscription term. |
termed_initial_period_type | any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are
|
renewal_type | any <varchar> (Renewal Type) The type of renewal for the subscription. |
renewal_period | any <int> (Renewal Period) The renewal period duration. |
renewal_period_type | any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are
|
is_auto_renew | any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no). |
trigger_dates | any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription. |
invoice_separate | any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no). |
total_amount | any <double> (Total Amount) The total amount associated with the subscription's plan-items.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
payment_status | any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid). |
created_at | any <timestamp> (Created At) The date and time when the subscription was created. |
suspended_at | any <timestamp> (Suspended At) The date and time when the subscription was suspended. |
cancelled_at | any <timestamp> (Cancelled At) The date and time when the subscription was cancelled. |
billing_end_date | any <date> (Billing End Date) The date when billing for the subscription ends. |
updated_at | any <timestamp> (Updated At) The date and time when the subscription was last updated. |
created_by | any <char> (Created By) The identifier of the user who created the subscription. |
updated_by | any <char> (Updated By) The identifier of the user who last updated the subscription. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the subscription is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the subscription is assigned. |
data_source | any <char> (Data Source) The source of data for the subscription. |
trial_period | any <int> (Trial Period) The duration of the trial period. |
trial_period_unit | any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are
|
is_gift | any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no). |
recipient_id | any <char> (Gift Recipient) The identifier of the recipient of the gift subscription. |
id | any <varchar> (Id) A unique and immutable identifier for the subscription. |
customer_id | any <char> (Customer) Identifier of the customer with whom this subscription is associated. |
items | any <array> (Items) Identifier of the plan and product with whom this subscription is associated. |
name | any <varchar> (Name) The name associated with this subscription. |
type | any <varchar> (Type) The type or category of the subscription. Possible values are
|
termed_start_date | any <date> (Term Start Date) The date when the subscription's term starts. |
termed_initial_period | any <int> (Term Initial Period) The initial period of the subscription term. |
termed_initial_period_type | any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are
|
renewal_type | any <varchar> (Renewal Type) The type of renewal for the subscription. |
renewal_period | any <int> (Renewal Period) The renewal period duration. |
renewal_period_type | any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are
|
is_auto_renew | any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no). |
trigger_dates | any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription. |
invoice_separate | any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no). |
total_amount | any <double> (Total Amount) The total amount associated with the subscription's plan-items.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
payment_status | any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid). |
created_at | any <timestamp> (Created At) The date and time when the subscription was created. |
suspended_at | any <timestamp> (Suspended At) The date and time when the subscription was suspended. |
cancelled_at | any <timestamp> (Cancelled At) The date and time when the subscription was cancelled. |
billing_end_date | any <date> (Billing End Date) The date when billing for the subscription ends. |
updated_at | any <timestamp> (Updated At) The date and time when the subscription was last updated. |
created_by | any <char> (Created By) The identifier of the user who created the subscription. |
updated_by | any <char> (Updated By) The identifier of the user who last updated the subscription. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the subscription is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the subscription is assigned. |
data_source | any <char> (Data Source) The source of data for the subscription. |
trial_period | any <int> (Trial Period) The duration of the trial period. |
trial_period_unit | any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are
|
is_gift | any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no). |
recipient_id | any <char> (Gift Recipient) The identifier of the recipient of the gift subscription. |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Deletes the subscription resource.
subscription required | char Subscription id |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns list of Subscriptions with all foreign keys
id | any <varchar> (Id) A unique and immutable identifier for the subscription. |
customer_id | any <char> (Customer) Identifier of the customer with whom this subscription is associated. |
items | any <array> (Items) Identifier of the plan and product with whom this subscription is associated. |
name | any <varchar> (Name) The name associated with this subscription. |
type | any <varchar> (Type) The type or category of the subscription. Possible values are
|
termed_start_date | any <date> (Term Start Date) The date when the subscription's term starts. |
termed_initial_period | any <int> (Term Initial Period) The initial period of the subscription term. |
termed_initial_period_type | any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are
|
renewal_type | any <varchar> (Renewal Type) The type of renewal for the subscription. |
renewal_period | any <int> (Renewal Period) The renewal period duration. |
renewal_period_type | any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are
|
is_auto_renew | any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no). |
trigger_dates | any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription. |
invoice_separate | any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no). |
total_amount | any <double> (Total Amount) The total amount associated with the subscription's plan-items.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
payment_status | any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid). |
created_at | any <timestamp> (Created At) The date and time when the subscription was created. |
suspended_at | any <timestamp> (Suspended At) The date and time when the subscription was suspended. |
cancelled_at | any <timestamp> (Cancelled At) The date and time when the subscription was cancelled. |
billing_end_date | any <date> (Billing End Date) The date when billing for the subscription ends. |
updated_at | any <timestamp> (Updated At) The date and time when the subscription was last updated. |
created_by | any <char> (Created By) The identifier of the user who created the subscription. |
updated_by | any <char> (Updated By) The identifier of the user who last updated the subscription. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the subscription is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the subscription is assigned. |
data_source | any <char> (Data Source) The source of data for the subscription. |
trial_period | any <int> (Trial Period) The duration of the trial period. |
trial_period_unit | any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are
|
is_gift | any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no). |
recipient_id | any <char> (Gift Recipient) The identifier of the recipient of the gift subscription. |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns list of Subscriptions with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <varchar> (Id) A unique and immutable identifier for the subscription. |
customer_id | any <char> (Customer) Identifier of the customer with whom this subscription is associated. |
items | any <array> (Items) Identifier of the plan and product with whom this subscription is associated. |
name | any <varchar> (Name) The name associated with this subscription. |
type | any <varchar> (Type) The type or category of the subscription. Possible values are
|
termed_start_date | any <date> (Term Start Date) The date when the subscription's term starts. |
termed_initial_period | any <int> (Term Initial Period) The initial period of the subscription term. |
termed_initial_period_type | any <varchar> (Term Initial Period Type) The type or unit of the initial period. Possible values are
|
renewal_type | any <varchar> (Renewal Type) The type of renewal for the subscription. |
renewal_period | any <int> (Renewal Period) The renewal period duration. |
renewal_period_type | any <varchar> (Renewal Period Type) The type or unit of the renewal period. Possible values are
|
is_auto_renew | any <tinyint> (Is Auto Renew) Indicates whether the subscription auto-renews (1 for yes, 0 for no). |
trigger_dates | any <date> (Trigger Dates) Dates or events that trigger actions related to the subscription. |
invoice_separate | any <date> (Invoice the Subscription Separately) Indicates if the subscription is separately invoiced (1 for yes, 0 for no). |
total_amount | any <double> (Total Amount) The total amount associated with the subscription's plan-items.
|
status | any <varchar> (Status) The current state of the subscription (e.g., active, suspended). Possible values are
|
payment_status | any <varchar> (Payment Status) The payment status of the subscription (e.g., pending, paid). |
created_at | any <timestamp> (Created At) The date and time when the subscription was created. |
suspended_at | any <timestamp> (Suspended At) The date and time when the subscription was suspended. |
cancelled_at | any <timestamp> (Cancelled At) The date and time when the subscription was cancelled. |
billing_end_date | any <date> (Billing End Date) The date when billing for the subscription ends. |
updated_at | any <timestamp> (Updated At) The date and time when the subscription was last updated. |
created_by | any <char> (Created By) The identifier of the user who created the subscription. |
updated_by | any <char> (Updated By) The identifier of the user who last updated the subscription. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the subscription is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the subscription is assigned. |
data_source | any <char> (Data Source) The source of data for the subscription. |
trial_period | any <int> (Trial Period) The duration of the trial period. |
trial_period_unit | any <varchar> (Trial Period Unit) The unit of the trial period duration. Possible values are
|
is_gift | any <tinyint> (Gift Subscription) Indicates if the subscription is a gift (1 for yes, 0 for no). |
recipient_id | any <char> (Gift Recipient) The identifier of the recipient of the gift subscription. |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns filtered Subscription data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns deleted Subscriptions data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns suspended Subscription data
suspension_option required | string The suspension option to use. Possible values are:
|
date | string <y-m-d> Date of suspension.
|
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns resumed Subscription data
resume_option required | string The resume option to use. Possible values are:
|
date | string <y-m-d> Date of resume.
|
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
Returns cancelled Subscription data
cancellation_option required | string The cancellation option to use. Possible values are:
|
date | string <y-m-d> Date of cancellation.
|
{- "id": "__test__sf5sukSOXduqmOY",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "items": [
- {
- "plan_id": "test-2d19-4c82-a783-a43cb6d0cb23",
- "product_id": "test-0596-4722-bf72-4b90008c31a5"
}
], - "name": "Premium Subscription",
- "type": "evergreen",
- "termed_start_date": "2023-11-01",
- "termed_initial_period": 30,
- "termed_initial_period_type": "days",
- "renewal_type": "monthly",
- "renewal_period": 30,
- "renewal_period_type": "day",
- "is_auto_renew": 1,
- "trigger_dates": "2023-12-01",
- "invoice_separate": 0,
- "total_amount": 99.99,
- "status": "active",
- "payment_status": "paid",
- "created_at": "2023-10-15T14:30:00Z",
- "suspended_at": "2023-11-05T10:45:00Z",
- "cancelled_at": "2023-11-20T16:15:00Z",
- "billing_end_date": "2023-12-01",
- "updated_at": "2023-11-25T08:20:00Z",
- "created_by": "user123",
- "updated_by": "admin456",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System",
- "trial_period": 15,
- "trial_period_unit": "days",
- "is_gift": 0,
- "recipient_id": "recipient123"
}
A usage is a record of a customer's usage of a product or service. The usage details include the usage ID, name, customer ID, subscription ID, charge ID, status, quantity, start date, end date, and description.
Returns list of Usages
id | any <varchar> (Id) A unique and immutable identifier for the usage. |
name | any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage". |
customer_id | any <varchar> (Customer) Identifier of the customer with whom this usage is associated. |
subscription_id | any <varchar> (Subscription) Identifier of the subscription with which this usage is associated. |
charge_id | any <varchar> (Charge) Identifier of the charge with which this usage is associated. |
status | any <varchar> (Status) The current state of the usage (e.g., processed) |
quantity | any <double> (Quantity) The quantity of the usage. |
start_date | any <date> (Start Date) The date when the usage starts. |
end_date | any <date> (End Date) The date when the usage ends. |
description | any <text> (Description) The description of the usage. |
created_at | any <datetime> (Created At) The date and time when the usage was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the usage is assigned. |
data_source | any <char> (Data Source) The source of data for the usage. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Returns Usage data
id | any <varchar> (Id) A unique and immutable identifier for the usage. |
name | any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage". |
customer_id | any <varchar> (Customer) Identifier of the customer with whom this usage is associated. |
subscription_id | any <varchar> (Subscription) Identifier of the subscription with which this usage is associated. |
charge_id | any <varchar> (Charge) Identifier of the charge with which this usage is associated. |
status | any <varchar> (Status) The current state of the usage (e.g., processed) |
quantity | any <double> (Quantity) The quantity of the usage. |
start_date | any <date> (Start Date) The date when the usage starts. |
end_date | any <date> (End Date) The date when the usage ends. |
description | any <text> (Description) The description of the usage. |
created_at | any <datetime> (Created At) The date and time when the usage was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the usage is assigned. |
data_source | any <char> (Data Source) The source of data for the usage. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Returns Usage data
usage required | char Usage id |
id | any <varchar> (Id) A unique and immutable identifier for the usage. |
name | any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage". |
customer_id | any <varchar> (Customer) Identifier of the customer with whom this usage is associated. |
subscription_id | any <varchar> (Subscription) Identifier of the subscription with which this usage is associated. |
charge_id | any <varchar> (Charge) Identifier of the charge with which this usage is associated. |
status | any <varchar> (Status) The current state of the usage (e.g., processed) |
quantity | any <double> (Quantity) The quantity of the usage. |
start_date | any <date> (Start Date) The date when the usage starts. |
end_date | any <date> (End Date) The date when the usage ends. |
description | any <text> (Description) The description of the usage. |
created_at | any <datetime> (Created At) The date and time when the usage was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the usage is assigned. |
data_source | any <char> (Data Source) The source of data for the usage. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Returns updated Usage data
usage required | char Usage id |
id | any <varchar> (Id) A unique and immutable identifier for the usage. |
name | any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage". |
customer_id | any <varchar> (Customer) Identifier of the customer with whom this usage is associated. |
subscription_id | any <varchar> (Subscription) Identifier of the subscription with which this usage is associated. |
charge_id | any <varchar> (Charge) Identifier of the charge with which this usage is associated. |
status | any <varchar> (Status) The current state of the usage (e.g., processed) |
quantity | any <double> (Quantity) The quantity of the usage. |
start_date | any <date> (Start Date) The date when the usage starts. |
end_date | any <date> (End Date) The date when the usage ends. |
description | any <text> (Description) The description of the usage. |
created_at | any <datetime> (Created At) The date and time when the usage was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the usage is assigned. |
data_source | any <char> (Data Source) The source of data for the usage. |
id | any <varchar> (Id) A unique and immutable identifier for the usage. |
name | any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage". |
customer_id | any <varchar> (Customer) Identifier of the customer with whom this usage is associated. |
subscription_id | any <varchar> (Subscription) Identifier of the subscription with which this usage is associated. |
charge_id | any <varchar> (Charge) Identifier of the charge with which this usage is associated. |
status | any <varchar> (Status) The current state of the usage (e.g., processed) |
quantity | any <double> (Quantity) The quantity of the usage. |
start_date | any <date> (Start Date) The date when the usage starts. |
end_date | any <date> (End Date) The date when the usage ends. |
description | any <text> (Description) The description of the usage. |
created_at | any <datetime> (Created At) The date and time when the usage was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the usage is assigned. |
data_source | any <char> (Data Source) The source of data for the usage. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Deletes a record and returns deleted record
usage required | char Usage id |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Returns list of Usages with all foreign keys
id | any <varchar> (Id) A unique and immutable identifier for the usage. |
name | any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage". |
customer_id | any <varchar> (Customer) Identifier of the customer with whom this usage is associated. |
subscription_id | any <varchar> (Subscription) Identifier of the subscription with which this usage is associated. |
charge_id | any <varchar> (Charge) Identifier of the charge with which this usage is associated. |
status | any <varchar> (Status) The current state of the usage (e.g., processed) |
quantity | any <double> (Quantity) The quantity of the usage. |
start_date | any <date> (Start Date) The date when the usage starts. |
end_date | any <date> (End Date) The date when the usage ends. |
description | any <text> (Description) The description of the usage. |
created_at | any <datetime> (Created At) The date and time when the usage was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the usage is assigned. |
data_source | any <char> (Data Source) The source of data for the usage. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Returns list of Usages with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <varchar> (Id) A unique and immutable identifier for the usage. |
name | any <varchar> (Name) The name associated with this usage. This is the name of the usage item. For example, "Data Usage". |
customer_id | any <varchar> (Customer) Identifier of the customer with whom this usage is associated. |
subscription_id | any <varchar> (Subscription) Identifier of the subscription with which this usage is associated. |
charge_id | any <varchar> (Charge) Identifier of the charge with which this usage is associated. |
status | any <varchar> (Status) The current state of the usage (e.g., processed) |
quantity | any <double> (Quantity) The quantity of the usage. |
start_date | any <date> (Start Date) The date when the usage starts. |
end_date | any <date> (End Date) The date when the usage ends. |
description | any <text> (Description) The description of the usage. |
created_at | any <datetime> (Created At) The date and time when the usage was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the usage is assigned. |
data_source | any <char> (Data Source) The source of data for the usage. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Returns filtered Usage data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
Returns deleted Usages data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Data Usage",
- "customer_id": "__test__sf5sukSOXdulGOV",
- "subscription_id": "__test__sf5sukSOXdulGOV",
- "charge_id": "__test__sf5sukSOXdulGOV",
- "status": "processed",
- "quantity": 100,
- "start_date": "2023-11-01",
- "end_date": "2023-11-30",
- "description": "Data Usage",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "data_source": "System"
}
An invoice is a document that itemizes a customer's charges for products and services. It is generated at the end of a billing cycle, which can be monthly, quarterly, or yearly. The invoice details include the invoice ID, name, customer ID, invoice date, due date, and total amount.
Returns list of Invoices
id | any <char> (Id) The unique identifier for the invoice. |
name | any <varchar> (Invoice Number) The invoice number. |
customer_id | any <char> (Customer) The identifier of the customer associated with the invoice. |
invoice_date | any <datetime> (Invoice Date) The date when the invoice was issued. |
due_date | any <datetime> (Due Date) The date when the invoice is due. |
terms | any <varchar> (Terms) The terms of payment for the invoice. |
status | any <varchar> (Status) The status of the invoice. Possible values:
|
discount_value | any <double> (Discount Value) The discount value of the invoice. |
tax_amount | any <double> (Total Tax) The total tax amount of the invoice. |
total_amount | any <double> (Total Amount) The total amount of the invoice. |
received_payment | any <double> (Received Payment) The total amount of payments received for the invoice. |
sum_of_credit_notes | any <double> (Credit Notes) The total amount of credit notes applied to the invoice. |
reversed_reference | any <varchar> (Reference of Reverse) The reference of the reverse invoice. |
created_at | any <timestamp> (Created At) The date and time when the invoice was created. |
updated_at | any <timestamp> (Updated At) The date and time when the invoice was last updated. |
opening_balance | any <decimal> (Opening Balance) The opening balance of the invoice. |
closing_balance | any <decimal> (Closing Balance) The closing balance of the invoice. |
created_by | any <char> (Created By) The user who created the invoice. |
updated_by | any <char> (Updated By) The user who last updated the invoice. |
assigned_to | any <char> (Assigned To) The user who is assigned to the invoice. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the invoice. |
data_source | any <char> (Data Source) The data source of the invoice. |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns Invoice data
id | any <char> (Id) The unique identifier for the invoice. |
name | any <varchar> (Invoice Number) The invoice number. |
customer_id | any <char> (Customer) The identifier of the customer associated with the invoice. |
invoice_date | any <datetime> (Invoice Date) The date when the invoice was issued. |
due_date | any <datetime> (Due Date) The date when the invoice is due. |
terms | any <varchar> (Terms) The terms of payment for the invoice. |
status | any <varchar> (Status) The status of the invoice. Possible values:
|
discount_value | any <double> (Discount Value) The discount value of the invoice. |
tax_amount | any <double> (Total Tax) The total tax amount of the invoice. |
total_amount | any <double> (Total Amount) The total amount of the invoice. |
received_payment | any <double> (Received Payment) The total amount of payments received for the invoice. |
sum_of_credit_notes | any <double> (Credit Notes) The total amount of credit notes applied to the invoice. |
reversed_reference | any <varchar> (Reference of Reverse) The reference of the reverse invoice. |
created_at | any <timestamp> (Created At) The date and time when the invoice was created. |
updated_at | any <timestamp> (Updated At) The date and time when the invoice was last updated. |
opening_balance | any <decimal> (Opening Balance) The opening balance of the invoice. |
closing_balance | any <decimal> (Closing Balance) The closing balance of the invoice. |
created_by | any <char> (Created By) The user who created the invoice. |
updated_by | any <char> (Updated By) The user who last updated the invoice. |
assigned_to | any <char> (Assigned To) The user who is assigned to the invoice. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the invoice. |
data_source | any <char> (Data Source) The data source of the invoice. |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns Invoice data
invoice required | char Invoice id |
id | any <char> (Id) The unique identifier for the invoice. |
name | any <varchar> (Invoice Number) The invoice number. |
customer_id | any <char> (Customer) The identifier of the customer associated with the invoice. |
invoice_date | any <datetime> (Invoice Date) The date when the invoice was issued. |
due_date | any <datetime> (Due Date) The date when the invoice is due. |
terms | any <varchar> (Terms) The terms of payment for the invoice. |
status | any <varchar> (Status) The status of the invoice. Possible values:
|
discount_value | any <double> (Discount Value) The discount value of the invoice. |
tax_amount | any <double> (Total Tax) The total tax amount of the invoice. |
total_amount | any <double> (Total Amount) The total amount of the invoice. |
received_payment | any <double> (Received Payment) The total amount of payments received for the invoice. |
sum_of_credit_notes | any <double> (Credit Notes) The total amount of credit notes applied to the invoice. |
reversed_reference | any <varchar> (Reference of Reverse) The reference of the reverse invoice. |
created_at | any <timestamp> (Created At) The date and time when the invoice was created. |
updated_at | any <timestamp> (Updated At) The date and time when the invoice was last updated. |
opening_balance | any <decimal> (Opening Balance) The opening balance of the invoice. |
closing_balance | any <decimal> (Closing Balance) The closing balance of the invoice. |
created_by | any <char> (Created By) The user who created the invoice. |
updated_by | any <char> (Updated By) The user who last updated the invoice. |
assigned_to | any <char> (Assigned To) The user who is assigned to the invoice. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the invoice. |
data_source | any <char> (Data Source) The data source of the invoice. |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns updated Invoice data
invoice required | char Invoice id |
id | any <char> (Id) The unique identifier for the invoice. |
name | any <varchar> (Invoice Number) The invoice number. |
customer_id | any <char> (Customer) The identifier of the customer associated with the invoice. |
invoice_date | any <datetime> (Invoice Date) The date when the invoice was issued. |
due_date | any <datetime> (Due Date) The date when the invoice is due. |
terms | any <varchar> (Terms) The terms of payment for the invoice. |
status | any <varchar> (Status) The status of the invoice. Possible values:
|
discount_value | any <double> (Discount Value) The discount value of the invoice. |
tax_amount | any <double> (Total Tax) The total tax amount of the invoice. |
total_amount | any <double> (Total Amount) The total amount of the invoice. |
received_payment | any <double> (Received Payment) The total amount of payments received for the invoice. |
sum_of_credit_notes | any <double> (Credit Notes) The total amount of credit notes applied to the invoice. |
reversed_reference | any <varchar> (Reference of Reverse) The reference of the reverse invoice. |
created_at | any <timestamp> (Created At) The date and time when the invoice was created. |
updated_at | any <timestamp> (Updated At) The date and time when the invoice was last updated. |
opening_balance | any <decimal> (Opening Balance) The opening balance of the invoice. |
closing_balance | any <decimal> (Closing Balance) The closing balance of the invoice. |
created_by | any <char> (Created By) The user who created the invoice. |
updated_by | any <char> (Updated By) The user who last updated the invoice. |
assigned_to | any <char> (Assigned To) The user who is assigned to the invoice. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the invoice. |
data_source | any <char> (Data Source) The data source of the invoice. |
id | any <char> (Id) The unique identifier for the invoice. |
name | any <varchar> (Invoice Number) The invoice number. |
customer_id | any <char> (Customer) The identifier of the customer associated with the invoice. |
invoice_date | any <datetime> (Invoice Date) The date when the invoice was issued. |
due_date | any <datetime> (Due Date) The date when the invoice is due. |
terms | any <varchar> (Terms) The terms of payment for the invoice. |
status | any <varchar> (Status) The status of the invoice. Possible values:
|
discount_value | any <double> (Discount Value) The discount value of the invoice. |
tax_amount | any <double> (Total Tax) The total tax amount of the invoice. |
total_amount | any <double> (Total Amount) The total amount of the invoice. |
received_payment | any <double> (Received Payment) The total amount of payments received for the invoice. |
sum_of_credit_notes | any <double> (Credit Notes) The total amount of credit notes applied to the invoice. |
reversed_reference | any <varchar> (Reference of Reverse) The reference of the reverse invoice. |
created_at | any <timestamp> (Created At) The date and time when the invoice was created. |
updated_at | any <timestamp> (Updated At) The date and time when the invoice was last updated. |
opening_balance | any <decimal> (Opening Balance) The opening balance of the invoice. |
closing_balance | any <decimal> (Closing Balance) The closing balance of the invoice. |
created_by | any <char> (Created By) The user who created the invoice. |
updated_by | any <char> (Updated By) The user who last updated the invoice. |
assigned_to | any <char> (Assigned To) The user who is assigned to the invoice. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the invoice. |
data_source | any <char> (Data Source) The data source of the invoice. |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Deletes a record and returns deleted record
invoice required | char Invoice id |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of Invoices with all foreign keys
id | any <char> (Id) The unique identifier for the invoice. |
name | any <varchar> (Invoice Number) The invoice number. |
customer_id | any <char> (Customer) The identifier of the customer associated with the invoice. |
invoice_date | any <datetime> (Invoice Date) The date when the invoice was issued. |
due_date | any <datetime> (Due Date) The date when the invoice is due. |
terms | any <varchar> (Terms) The terms of payment for the invoice. |
status | any <varchar> (Status) The status of the invoice. Possible values:
|
discount_value | any <double> (Discount Value) The discount value of the invoice. |
tax_amount | any <double> (Total Tax) The total tax amount of the invoice. |
total_amount | any <double> (Total Amount) The total amount of the invoice. |
received_payment | any <double> (Received Payment) The total amount of payments received for the invoice. |
sum_of_credit_notes | any <double> (Credit Notes) The total amount of credit notes applied to the invoice. |
reversed_reference | any <varchar> (Reference of Reverse) The reference of the reverse invoice. |
created_at | any <timestamp> (Created At) The date and time when the invoice was created. |
updated_at | any <timestamp> (Updated At) The date and time when the invoice was last updated. |
opening_balance | any <decimal> (Opening Balance) The opening balance of the invoice. |
closing_balance | any <decimal> (Closing Balance) The closing balance of the invoice. |
created_by | any <char> (Created By) The user who created the invoice. |
updated_by | any <char> (Updated By) The user who last updated the invoice. |
assigned_to | any <char> (Assigned To) The user who is assigned to the invoice. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the invoice. |
data_source | any <char> (Data Source) The data source of the invoice. |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of Invoices with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <char> (Id) The unique identifier for the invoice. |
name | any <varchar> (Invoice Number) The invoice number. |
customer_id | any <char> (Customer) The identifier of the customer associated with the invoice. |
invoice_date | any <datetime> (Invoice Date) The date when the invoice was issued. |
due_date | any <datetime> (Due Date) The date when the invoice is due. |
terms | any <varchar> (Terms) The terms of payment for the invoice. |
status | any <varchar> (Status) The status of the invoice. Possible values:
|
discount_value | any <double> (Discount Value) The discount value of the invoice. |
tax_amount | any <double> (Total Tax) The total tax amount of the invoice. |
total_amount | any <double> (Total Amount) The total amount of the invoice. |
received_payment | any <double> (Received Payment) The total amount of payments received for the invoice. |
sum_of_credit_notes | any <double> (Credit Notes) The total amount of credit notes applied to the invoice. |
reversed_reference | any <varchar> (Reference of Reverse) The reference of the reverse invoice. |
created_at | any <timestamp> (Created At) The date and time when the invoice was created. |
updated_at | any <timestamp> (Updated At) The date and time when the invoice was last updated. |
opening_balance | any <decimal> (Opening Balance) The opening balance of the invoice. |
closing_balance | any <decimal> (Closing Balance) The closing balance of the invoice. |
created_by | any <char> (Created By) The user who created the invoice. |
updated_by | any <char> (Updated By) The user who last updated the invoice. |
assigned_to | any <char> (Assigned To) The user who is assigned to the invoice. |
assigned_group_id | any <char> (Assigned Group) The group that is assigned to the invoice. |
data_source | any <char> (Data Source) The data source of the invoice. |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns filtered Invoice data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns deleted Invoices data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__in3VnHhSBWl7eY2bl",
- "name": "INV-0001",
- "customer_id": "__test__cs3VnHhSBWl7eY2bl",
- "invoice_date": "2020-01-01T00:00:00Z",
- "due_date": "2020-01-01T00:00:00Z",
- "terms": "Net 30",
- "status": "due",
- "discount_value": 0,
- "tax_amount": 0,
- "total_amount": 0,
- "received_payment": 0,
- "sum_of_credit_notes": 0,
- "reversed_reference": "",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "opening_balance": 0,
- "closing_balance": 0,
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "assigned_group_id": "__test__gr3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
A transaction is a record of a payment that has been processed for a customer. The transaction details include the transaction ID, name, customer ID, transaction date, status, amount, and payment method.
The transaction status can be one of the following:
Returns list of Transactions
id | any <varchar> (Id) A unique and immutable identifier for the transaction. |
name | any <varchar> (Name) The name associated with this transaction. |
date | any <date> (Date) The date when the transaction was created. |
status | any <varchar> (Status) The status of the transaction. Possible values are
|
amount | any <double> (Amount) The amount of the transaction. |
unapplied_amount | any <double> (Unapplied Amount) The unapplied amount of the transaction. |
balance | any <double> (Balance) The balance of the transaction. |
number | any <varchar> (Transaction ID) The unique identifier of the transaction. |
api_response | any <varchar> (API Response) The API response of the transaction. |
payment_type_id | any <varchar> (Payment Method) The identifier of the payment method associated with the transaction. |
payment_method_id | any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction. |
cash_or_card | any <varchar> (Payment Source) The payment source of the transaction. Possible values are
|
customer_id | any <varchar> (Customer) The identifier of the customer associated with the transaction. |
type | any <varchar> (Type) The type of the transaction. |
transaction_category | any <varchar> (Transaction Category) The category of the transaction. |
reference | any <varchar> (Reference) The reference of the transaction. |
description | any <text> (Description) The description of the transaction. |
transaction_id | any <varchar> (Unique Transaction Number) The unique transaction number of the transaction. |
reference_transaction_id | any <varchar> (Reference Transaction Id) The identifier of the reference transaction. |
decline_reason | any <text> (Declined Reason) The reason for the transaction decline. |
accounting_account_code | any <varchar> (Account Code) The accounting account code of the transaction. |
created_at | any <timestamp> (Created At) The date and time when the transaction was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the transaction is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the transaction is assigned. |
data_source | any <char> (Data Source) The source of data for the transaction. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Returns Transaction data
id | any <varchar> (Id) A unique and immutable identifier for the transaction. |
name | any <varchar> (Name) The name associated with this transaction. |
date | any <date> (Date) The date when the transaction was created. |
status | any <varchar> (Status) The status of the transaction. Possible values are
|
amount | any <double> (Amount) The amount of the transaction. |
unapplied_amount | any <double> (Unapplied Amount) The unapplied amount of the transaction. |
balance | any <double> (Balance) The balance of the transaction. |
number | any <varchar> (Transaction ID) The unique identifier of the transaction. |
api_response | any <varchar> (API Response) The API response of the transaction. |
payment_type_id | any <varchar> (Payment Method) The identifier of the payment method associated with the transaction. |
payment_method_id | any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction. |
cash_or_card | any <varchar> (Payment Source) The payment source of the transaction. Possible values are
|
customer_id | any <varchar> (Customer) The identifier of the customer associated with the transaction. |
type | any <varchar> (Type) The type of the transaction. |
transaction_category | any <varchar> (Transaction Category) The category of the transaction. |
reference | any <varchar> (Reference) The reference of the transaction. |
description | any <text> (Description) The description of the transaction. |
transaction_id | any <varchar> (Unique Transaction Number) The unique transaction number of the transaction. |
reference_transaction_id | any <varchar> (Reference Transaction Id) The identifier of the reference transaction. |
decline_reason | any <text> (Declined Reason) The reason for the transaction decline. |
accounting_account_code | any <varchar> (Account Code) The accounting account code of the transaction. |
created_at | any <timestamp> (Created At) The date and time when the transaction was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the transaction is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the transaction is assigned. |
data_source | any <char> (Data Source) The source of data for the transaction. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Returns Transaction data
transaction required | char Transaction id |
id | any <varchar> (Id) A unique and immutable identifier for the transaction. |
name | any <varchar> (Name) The name associated with this transaction. |
date | any <date> (Date) The date when the transaction was created. |
status | any <varchar> (Status) The status of the transaction. Possible values are
|
amount | any <double> (Amount) The amount of the transaction. |
unapplied_amount | any <double> (Unapplied Amount) The unapplied amount of the transaction. |
balance | any <double> (Balance) The balance of the transaction. |
number | any <varchar> (Transaction ID) The unique identifier of the transaction. |
api_response | any <varchar> (API Response) The API response of the transaction. |
payment_type_id | any <varchar> (Payment Method) The identifier of the payment method associated with the transaction. |
payment_method_id | any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction. |
cash_or_card | any <varchar> (Payment Source) The payment source of the transaction. Possible values are
|
customer_id | any <varchar> (Customer) The identifier of the customer associated with the transaction. |
type | any <varchar> (Type) The type of the transaction. |
transaction_category | any <varchar> (Transaction Category) The category of the transaction. |
reference | any <varchar> (Reference) The reference of the transaction. |
description | any <text> (Description) The description of the transaction. |
transaction_id | any <varchar> (Unique Transaction Number) The unique transaction number of the transaction. |
reference_transaction_id | any <varchar> (Reference Transaction Id) The identifier of the reference transaction. |
decline_reason | any <text> (Declined Reason) The reason for the transaction decline. |
accounting_account_code | any <varchar> (Account Code) The accounting account code of the transaction. |
created_at | any <timestamp> (Created At) The date and time when the transaction was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the transaction is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the transaction is assigned. |
data_source | any <char> (Data Source) The source of data for the transaction. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Returns updated Transaction data
transaction required | char Transaction id |
id | any <varchar> (Id) A unique and immutable identifier for the transaction. |
name | any <varchar> (Name) The name associated with this transaction. |
date | any <date> (Date) The date when the transaction was created. |
status | any <varchar> (Status) The status of the transaction. Possible values are
|
amount | any <double> (Amount) The amount of the transaction. |
unapplied_amount | any <double> (Unapplied Amount) The unapplied amount of the transaction. |
balance | any <double> (Balance) The balance of the transaction. |
number | any <varchar> (Transaction ID) The unique identifier of the transaction. |
api_response | any <varchar> (API Response) The API response of the transaction. |
payment_type_id | any <varchar> (Payment Method) The identifier of the payment method associated with the transaction. |
payment_method_id | any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction. |
cash_or_card | any <varchar> (Payment Source) The payment source of the transaction. Possible values are
|
customer_id | any <varchar> (Customer) The identifier of the customer associated with the transaction. |
type | any <varchar> (Type) The type of the transaction. |
transaction_category | any <varchar> (Transaction Category) The category of the transaction. |
reference | any <varchar> (Reference) The reference of the transaction. |
description | any <text> (Description) The description of the transaction. |
transaction_id | any <varchar> (Unique Transaction Number) The unique transaction number of the transaction. |
reference_transaction_id | any <varchar> (Reference Transaction Id) The identifier of the reference transaction. |
decline_reason | any <text> (Declined Reason) The reason for the transaction decline. |
accounting_account_code | any <varchar> (Account Code) The accounting account code of the transaction. |
created_at | any <timestamp> (Created At) The date and time when the transaction was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the transaction is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the transaction is assigned. |
data_source | any <char> (Data Source) The source of data for the transaction. |
id | any <varchar> (Id) A unique and immutable identifier for the transaction. |
name | any <varchar> (Name) The name associated with this transaction. |
date | any <date> (Date) The date when the transaction was created. |
status | any <varchar> (Status) The status of the transaction. Possible values are
|
amount | any <double> (Amount) The amount of the transaction. |
unapplied_amount | any <double> (Unapplied Amount) The unapplied amount of the transaction. |
balance | any <double> (Balance) The balance of the transaction. |
number | any <varchar> (Transaction ID) The unique identifier of the transaction. |
api_response | any <varchar> (API Response) The API response of the transaction. |
payment_type_id | any <varchar> (Payment Method) The identifier of the payment method associated with the transaction. |
payment_method_id | any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction. |
cash_or_card | any <varchar> (Payment Source) The payment source of the transaction. Possible values are
|
customer_id | any <varchar> (Customer) The identifier of the customer associated with the transaction. |
type | any <varchar> (Type) The type of the transaction. |
transaction_category | any <varchar> (Transaction Category) The category of the transaction. |
reference | any <varchar> (Reference) The reference of the transaction. |
description | any <text> (Description) The description of the transaction. |
transaction_id | any <varchar> (Unique Transaction Number) The unique transaction number of the transaction. |
reference_transaction_id | any <varchar> (Reference Transaction Id) The identifier of the reference transaction. |
decline_reason | any <text> (Declined Reason) The reason for the transaction decline. |
accounting_account_code | any <varchar> (Account Code) The accounting account code of the transaction. |
created_at | any <timestamp> (Created At) The date and time when the transaction was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the transaction is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the transaction is assigned. |
data_source | any <char> (Data Source) The source of data for the transaction. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Deletes a record and returns deleted record
transaction required | char Transaction id |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Returns list of Transactions with all foreign keys
id | any <varchar> (Id) A unique and immutable identifier for the transaction. |
name | any <varchar> (Name) The name associated with this transaction. |
date | any <date> (Date) The date when the transaction was created. |
status | any <varchar> (Status) The status of the transaction. Possible values are
|
amount | any <double> (Amount) The amount of the transaction. |
unapplied_amount | any <double> (Unapplied Amount) The unapplied amount of the transaction. |
balance | any <double> (Balance) The balance of the transaction. |
number | any <varchar> (Transaction ID) The unique identifier of the transaction. |
api_response | any <varchar> (API Response) The API response of the transaction. |
payment_type_id | any <varchar> (Payment Method) The identifier of the payment method associated with the transaction. |
payment_method_id | any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction. |
cash_or_card | any <varchar> (Payment Source) The payment source of the transaction. Possible values are
|
customer_id | any <varchar> (Customer) The identifier of the customer associated with the transaction. |
type | any <varchar> (Type) The type of the transaction. |
transaction_category | any <varchar> (Transaction Category) The category of the transaction. |
reference | any <varchar> (Reference) The reference of the transaction. |
description | any <text> (Description) The description of the transaction. |
transaction_id | any <varchar> (Unique Transaction Number) The unique transaction number of the transaction. |
reference_transaction_id | any <varchar> (Reference Transaction Id) The identifier of the reference transaction. |
decline_reason | any <text> (Declined Reason) The reason for the transaction decline. |
accounting_account_code | any <varchar> (Account Code) The accounting account code of the transaction. |
created_at | any <timestamp> (Created At) The date and time when the transaction was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the transaction is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the transaction is assigned. |
data_source | any <char> (Data Source) The source of data for the transaction. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Returns list of Transactions with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <varchar> (Id) A unique and immutable identifier for the transaction. |
name | any <varchar> (Name) The name associated with this transaction. |
date | any <date> (Date) The date when the transaction was created. |
status | any <varchar> (Status) The status of the transaction. Possible values are
|
amount | any <double> (Amount) The amount of the transaction. |
unapplied_amount | any <double> (Unapplied Amount) The unapplied amount of the transaction. |
balance | any <double> (Balance) The balance of the transaction. |
number | any <varchar> (Transaction ID) The unique identifier of the transaction. |
api_response | any <varchar> (API Response) The API response of the transaction. |
payment_type_id | any <varchar> (Payment Method) The identifier of the payment method associated with the transaction. |
payment_method_id | any <varchar> (Payment Method ID) The identifier of the payment method associated with the transaction. |
cash_or_card | any <varchar> (Payment Source) The payment source of the transaction. Possible values are
|
customer_id | any <varchar> (Customer) The identifier of the customer associated with the transaction. |
type | any <varchar> (Type) The type of the transaction. |
transaction_category | any <varchar> (Transaction Category) The category of the transaction. |
reference | any <varchar> (Reference) The reference of the transaction. |
description | any <text> (Description) The description of the transaction. |
transaction_id | any <varchar> (Unique Transaction Number) The unique transaction number of the transaction. |
reference_transaction_id | any <varchar> (Reference Transaction Id) The identifier of the reference transaction. |
decline_reason | any <text> (Declined Reason) The reason for the transaction decline. |
accounting_account_code | any <varchar> (Account Code) The accounting account code of the transaction. |
created_at | any <timestamp> (Created At) The date and time when the transaction was created. |
assigned_to | any <char> (Assigned To) The identifier of the user to whom the transaction is assigned. |
assigned_group_id | any <char> (Assigned Group) The identifier of the group to which the transaction is assigned. |
data_source | any <char> (Data Source) The source of data for the transaction. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Returns filtered Transaction data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
Returns deleted Transactions data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__sf5sukSOXduqmOY",
- "name": "Premium Subscription",
- "date": "2023-11-01",
- "status": "success",
- "amount": 100,
- "unapplied_amount": 0,
- "balance": 0,
- "number": "__test__sf5sukSOXduqmOY",
- "api_response": "",
- "payment_type_id": "__test__sf5sukSOXduqmOY",
- "payment_method_id": "__test__sf5sukSOXduqmOY",
- "cash_or_card": "card",
- "customer_id": "__test__sf5sukSOXduqmOY",
- "type": "payment",
- "transaction_category": "payment",
- "reference": "",
- "description": "Payment for subscription",
- "transaction_id": "__test__sf5sukSOXduqmOY",
- "reference_transaction_id": "__test__sf5sukSOXduqmOY",
- "decline_reason": "",
- "accounting_account_code": "",
- "created_at": "2023-10-15T14:30:00Z",
- "assigned_to": "user789",
- "assigned_group_id": "group123",
- "data_source": "System"
}
A product is a good or service that you sell to your customers. The product details include the product ID, name, type, description, SKU, effective start date, effective end date, and status. Product have line items called plan-items that define the billing details for the product.
Possible values for product type are
Possible values for product status are
Returns list of Products
id | any <char> (Id) The unique identifier for the product. |
name | any <varchar> (Name) The name of the product. This is the name that appears on the invoice. |
description | any <text> (Description) The description of the product. This is the description that appears on the invoice. |
sku | any <varchar> (SKU) The stock keeping unit (SKU) of the product. |
effective_start_date | any <datetime> (Effective Start Date) The date when the product becomes effective. The product is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the product expires. The product is no longer available for purchase starting from this date. |
type | any <varchar> (Type) The type of the product. Possible values:
|
manager_id | any <char> (Manager) The identifier of the manager associated with the product. |
status | any <varchar> (Status) The status of the product. Possible values:
|
image | any <varchar> (Image) The URL of an image for the product. |
created_at | any <timestamp> (Created At) The date and time when the product was created. |
updated_at | any <timestamp> (Updated At) The date and time when the product was last updated. |
created_by | any <char> (Created By) The user who created the product. |
updated_by | any <char> (Updated By) The user who last updated the product. |
assigned_to | any <char> (Assigned To) The user who is assigned to the product. |
data_source | any <char> (Data Source) The data source of the product. |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns Product data
id | any <char> (Id) The unique identifier for the product. |
name | any <varchar> (Name) The name of the product. This is the name that appears on the invoice. |
description | any <text> (Description) The description of the product. This is the description that appears on the invoice. |
sku | any <varchar> (SKU) The stock keeping unit (SKU) of the product. |
effective_start_date | any <datetime> (Effective Start Date) The date when the product becomes effective. The product is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the product expires. The product is no longer available for purchase starting from this date. |
type | any <varchar> (Type) The type of the product. Possible values:
|
manager_id | any <char> (Manager) The identifier of the manager associated with the product. |
status | any <varchar> (Status) The status of the product. Possible values:
|
image | any <varchar> (Image) The URL of an image for the product. |
created_at | any <timestamp> (Created At) The date and time when the product was created. |
updated_at | any <timestamp> (Updated At) The date and time when the product was last updated. |
created_by | any <char> (Created By) The user who created the product. |
updated_by | any <char> (Updated By) The user who last updated the product. |
assigned_to | any <char> (Assigned To) The user who is assigned to the product. |
data_source | any <char> (Data Source) The data source of the product. |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns Product data
product required | char Product id |
id | any <char> (Id) The unique identifier for the product. |
name | any <varchar> (Name) The name of the product. This is the name that appears on the invoice. |
description | any <text> (Description) The description of the product. This is the description that appears on the invoice. |
sku | any <varchar> (SKU) The stock keeping unit (SKU) of the product. |
effective_start_date | any <datetime> (Effective Start Date) The date when the product becomes effective. The product is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the product expires. The product is no longer available for purchase starting from this date. |
type | any <varchar> (Type) The type of the product. Possible values:
|
manager_id | any <char> (Manager) The identifier of the manager associated with the product. |
status | any <varchar> (Status) The status of the product. Possible values:
|
image | any <varchar> (Image) The URL of an image for the product. |
created_at | any <timestamp> (Created At) The date and time when the product was created. |
updated_at | any <timestamp> (Updated At) The date and time when the product was last updated. |
created_by | any <char> (Created By) The user who created the product. |
updated_by | any <char> (Updated By) The user who last updated the product. |
assigned_to | any <char> (Assigned To) The user who is assigned to the product. |
data_source | any <char> (Data Source) The data source of the product. |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns updated Product data
product required | char Product id |
id | any <char> (Id) The unique identifier for the product. |
name | any <varchar> (Name) The name of the product. This is the name that appears on the invoice. |
description | any <text> (Description) The description of the product. This is the description that appears on the invoice. |
sku | any <varchar> (SKU) The stock keeping unit (SKU) of the product. |
effective_start_date | any <datetime> (Effective Start Date) The date when the product becomes effective. The product is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the product expires. The product is no longer available for purchase starting from this date. |
type | any <varchar> (Type) The type of the product. Possible values:
|
manager_id | any <char> (Manager) The identifier of the manager associated with the product. |
status | any <varchar> (Status) The status of the product. Possible values:
|
image | any <varchar> (Image) The URL of an image for the product. |
created_at | any <timestamp> (Created At) The date and time when the product was created. |
updated_at | any <timestamp> (Updated At) The date and time when the product was last updated. |
created_by | any <char> (Created By) The user who created the product. |
updated_by | any <char> (Updated By) The user who last updated the product. |
assigned_to | any <char> (Assigned To) The user who is assigned to the product. |
data_source | any <char> (Data Source) The data source of the product. |
id | any <char> (Id) The unique identifier for the product. |
name | any <varchar> (Name) The name of the product. This is the name that appears on the invoice. |
description | any <text> (Description) The description of the product. This is the description that appears on the invoice. |
sku | any <varchar> (SKU) The stock keeping unit (SKU) of the product. |
effective_start_date | any <datetime> (Effective Start Date) The date when the product becomes effective. The product is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the product expires. The product is no longer available for purchase starting from this date. |
type | any <varchar> (Type) The type of the product. Possible values:
|
manager_id | any <char> (Manager) The identifier of the manager associated with the product. |
status | any <varchar> (Status) The status of the product. Possible values:
|
image | any <varchar> (Image) The URL of an image for the product. |
created_at | any <timestamp> (Created At) The date and time when the product was created. |
updated_at | any <timestamp> (Updated At) The date and time when the product was last updated. |
created_by | any <char> (Created By) The user who created the product. |
updated_by | any <char> (Updated By) The user who last updated the product. |
assigned_to | any <char> (Assigned To) The user who is assigned to the product. |
data_source | any <char> (Data Source) The data source of the product. |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Deletes a record and returns deleted record
product required | char Product id |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of Products with all foreign keys
id | any <char> (Id) The unique identifier for the product. |
name | any <varchar> (Name) The name of the product. This is the name that appears on the invoice. |
description | any <text> (Description) The description of the product. This is the description that appears on the invoice. |
sku | any <varchar> (SKU) The stock keeping unit (SKU) of the product. |
effective_start_date | any <datetime> (Effective Start Date) The date when the product becomes effective. The product is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the product expires. The product is no longer available for purchase starting from this date. |
type | any <varchar> (Type) The type of the product. Possible values:
|
manager_id | any <char> (Manager) The identifier of the manager associated with the product. |
status | any <varchar> (Status) The status of the product. Possible values:
|
image | any <varchar> (Image) The URL of an image for the product. |
created_at | any <timestamp> (Created At) The date and time when the product was created. |
updated_at | any <timestamp> (Updated At) The date and time when the product was last updated. |
created_by | any <char> (Created By) The user who created the product. |
updated_by | any <char> (Updated By) The user who last updated the product. |
assigned_to | any <char> (Assigned To) The user who is assigned to the product. |
data_source | any <char> (Data Source) The data source of the product. |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of Products with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <char> (Id) The unique identifier for the product. |
name | any <varchar> (Name) The name of the product. This is the name that appears on the invoice. |
description | any <text> (Description) The description of the product. This is the description that appears on the invoice. |
sku | any <varchar> (SKU) The stock keeping unit (SKU) of the product. |
effective_start_date | any <datetime> (Effective Start Date) The date when the product becomes effective. The product is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the product expires. The product is no longer available for purchase starting from this date. |
type | any <varchar> (Type) The type of the product. Possible values:
|
manager_id | any <char> (Manager) The identifier of the manager associated with the product. |
status | any <varchar> (Status) The status of the product. Possible values:
|
image | any <varchar> (Image) The URL of an image for the product. |
created_at | any <timestamp> (Created At) The date and time when the product was created. |
updated_at | any <timestamp> (Updated At) The date and time when the product was last updated. |
created_by | any <char> (Created By) The user who created the product. |
updated_by | any <char> (Updated By) The user who last updated the product. |
assigned_to | any <char> (Assigned To) The user who is assigned to the product. |
data_source | any <char> (Data Source) The data source of the product. |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns filtered Product data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns deleted Products data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__pr3VnHhSBWl7eY2bl",
- "name": "Product 1",
- "description": "Product 1 description",
- "sku": "SKU-0001",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "type": "Base Product",
- "manager_id": "__test__us3VnHhSBWl7eY2bl",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
A plan is a set of billing details for a product. The plan details include the plan ID, name, description, effective start date, effective end date, and status. Plans have line items called plan-items that define the billing details for the plan.
Possible values for plan status are
Note: A plan can be associated with multiple products.
Returns list of Plans
id | any <char> (Id) The unique identifier for the plan. |
name | any <varchar> (Name) The name of the plan. |
description | any <text> (Description) The description of the plan. |
effective_start_date | any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date. |
status | any <varchar> (Status) The status of the plan. Possible values:
|
created_at | any <timestamp> (Created At) The date and time when the plan was created. |
updated_at | any <timestamp> (Updated At) The date and time when the plan was last updated. |
created_by | any <char> (Created By) The user who created the plan. |
updated_by | any <char> (Updated By) The user who last updated the plan. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan. |
data_source | any <char> (Data Source) The data source of the plan. |
is_gift | any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan. |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Returns Plan data
id | any <char> (Id) The unique identifier for the plan. |
name | any <varchar> (Name) The name of the plan. |
description | any <text> (Description) The description of the plan. |
effective_start_date | any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date. |
status | any <varchar> (Status) The status of the plan. Possible values:
|
created_at | any <timestamp> (Created At) The date and time when the plan was created. |
updated_at | any <timestamp> (Updated At) The date and time when the plan was last updated. |
created_by | any <char> (Created By) The user who created the plan. |
updated_by | any <char> (Updated By) The user who last updated the plan. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan. |
data_source | any <char> (Data Source) The data source of the plan. |
is_gift | any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan. |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Returns Plan data
plan required | char Plan id |
id | any <char> (Id) The unique identifier for the plan. |
name | any <varchar> (Name) The name of the plan. |
description | any <text> (Description) The description of the plan. |
effective_start_date | any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date. |
status | any <varchar> (Status) The status of the plan. Possible values:
|
created_at | any <timestamp> (Created At) The date and time when the plan was created. |
updated_at | any <timestamp> (Updated At) The date and time when the plan was last updated. |
created_by | any <char> (Created By) The user who created the plan. |
updated_by | any <char> (Updated By) The user who last updated the plan. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan. |
data_source | any <char> (Data Source) The data source of the plan. |
is_gift | any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan. |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Returns updated Plan data
plan required | char Plan id |
id | any <char> (Id) The unique identifier for the plan. |
name | any <varchar> (Name) The name of the plan. |
description | any <text> (Description) The description of the plan. |
effective_start_date | any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date. |
status | any <varchar> (Status) The status of the plan. Possible values:
|
created_at | any <timestamp> (Created At) The date and time when the plan was created. |
updated_at | any <timestamp> (Updated At) The date and time when the plan was last updated. |
created_by | any <char> (Created By) The user who created the plan. |
updated_by | any <char> (Updated By) The user who last updated the plan. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan. |
data_source | any <char> (Data Source) The data source of the plan. |
is_gift | any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan. |
id | any <char> (Id) The unique identifier for the plan. |
name | any <varchar> (Name) The name of the plan. |
description | any <text> (Description) The description of the plan. |
effective_start_date | any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date. |
status | any <varchar> (Status) The status of the plan. Possible values:
|
created_at | any <timestamp> (Created At) The date and time when the plan was created. |
updated_at | any <timestamp> (Updated At) The date and time when the plan was last updated. |
created_by | any <char> (Created By) The user who created the plan. |
updated_by | any <char> (Updated By) The user who last updated the plan. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan. |
data_source | any <char> (Data Source) The data source of the plan. |
is_gift | any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan. |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Deletes a record and returns deleted record
plan required | char Plan id |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Returns list of Plans with all foreign keys
id | any <char> (Id) The unique identifier for the plan. |
name | any <varchar> (Name) The name of the plan. |
description | any <text> (Description) The description of the plan. |
effective_start_date | any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date. |
status | any <varchar> (Status) The status of the plan. Possible values:
|
created_at | any <timestamp> (Created At) The date and time when the plan was created. |
updated_at | any <timestamp> (Updated At) The date and time when the plan was last updated. |
created_by | any <char> (Created By) The user who created the plan. |
updated_by | any <char> (Updated By) The user who last updated the plan. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan. |
data_source | any <char> (Data Source) The data source of the plan. |
is_gift | any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan. |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Returns list of Plans with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <char> (Id) The unique identifier for the plan. |
name | any <varchar> (Name) The name of the plan. |
description | any <text> (Description) The description of the plan. |
effective_start_date | any <datetime> (Effective Start Date) The date when the plan becomes effective. The plan is available for purchase starting from this date. |
effective_end_date | any <datetime> (Effective End Date) The date when the plan expires. The plan is no longer available for purchase starting from this date. |
status | any <varchar> (Status) The status of the plan. Possible values:
|
created_at | any <timestamp> (Created At) The date and time when the plan was created. |
updated_at | any <timestamp> (Updated At) The date and time when the plan was last updated. |
created_by | any <char> (Created By) The user who created the plan. |
updated_by | any <char> (Updated By) The user who last updated the plan. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan. |
data_source | any <char> (Data Source) The data source of the plan. |
is_gift | any <tinyint> (Is Gift Plan) Indicates whether the plan is a gift plan. |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Returns filtered Plan data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
Returns deleted Plans data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__pl3VnHhSBWl7eY2bl",
- "name": "Plan 1",
- "description": "Plan 1 description",
- "effective_start_date": "2020-01-01T00:00:00Z",
- "effective_end_date": "2020-01-01T00:00:00Z",
- "status": "active",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__us3VnHhSBWl7eY2bl",
- "updated_by": "__test__us3VnHhSBWl7eY2bl",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl",
- "is_gift": 0
}
A plan-item is a line item that defines the billing details for a product or plan. The plan-item details include the plan-item ID, name, description, category, charge model, accounting account code, list price, list price base, UOM, included units, default quantity, trigger condition, end date, billing timing, billing period alignment, usage records rating option, billing period, billing period months weeks, billing month, billing day type, billing week day, and status.
Returns list of PlanPrice
id | any <varchar> (Id) The unique identifier for the plan price. |
plan_id | any <int> (Plan Id) The identifier of the plan associated with the plan price. |
product_id | any <int> (Product Id) The identifier of the product associated with the plan price. |
name | any <int> (Name) The name of the plan price. |
description | any <varchar> (Description) The description of the plan price. |
category | any <date> (Category) The category of the plan price. |
charge_model | any <varchar> (Charge Model) The charge model of the plan price. Possible values:
|
accounting_account_code | any <varchar> (Account) The accounting account code of the plan price. |
list_price | any <double> (List Price) The list price of the plan price. |
list_price_base | any <varchar> (List Price Base) The list price base of the plan price. |
uom | any <varchar> (UOM) The unit of measure (UOM) of the plan price. |
included_units | any <varchar> (Included Units) The included units of the plan price. |
default_quantity | any <varchar> (Default Quantity) The default quantity of the plan price. |
trigger_condition | any <varchar> (Trigger Condition) The trigger condition of the plan price. |
end_date | any <varchar> (End Date) The end date of the plan price. |
billing_timming | any <varchar> (Billing Timming) The billing timming of the plan price. Possible values:
|
billing_period_alignment | any <varchar> (Billing Period Alignment) The billing period alignment of the plan price. |
usage_records_rating_option | any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price. |
billing_period_id | any <int> (Billing Period) The identifier of the billing period associated with the plan price. |
billing_period_months_weeks | any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price. |
billing_month_id | any <int> (Billing Month) The identifier of the billing month associated with the plan price. |
billing_day_type_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
billing_week_day_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
created_at | any <timestamp> (Created At) The date and time when the plan price was created. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan price. |
data_source | any <char> (Data Source) The data source of the plan price. |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns PlanPrice data
id | any <varchar> (Id) The unique identifier for the plan price. |
plan_id | any <int> (Plan Id) The identifier of the plan associated with the plan price. |
product_id | any <int> (Product Id) The identifier of the product associated with the plan price. |
name | any <int> (Name) The name of the plan price. |
description | any <varchar> (Description) The description of the plan price. |
category | any <date> (Category) The category of the plan price. |
charge_model | any <varchar> (Charge Model) The charge model of the plan price. Possible values:
|
accounting_account_code | any <varchar> (Account) The accounting account code of the plan price. |
list_price | any <double> (List Price) The list price of the plan price. |
list_price_base | any <varchar> (List Price Base) The list price base of the plan price. |
uom | any <varchar> (UOM) The unit of measure (UOM) of the plan price. |
included_units | any <varchar> (Included Units) The included units of the plan price. |
default_quantity | any <varchar> (Default Quantity) The default quantity of the plan price. |
trigger_condition | any <varchar> (Trigger Condition) The trigger condition of the plan price. |
end_date | any <varchar> (End Date) The end date of the plan price. |
billing_timming | any <varchar> (Billing Timming) The billing timming of the plan price. Possible values:
|
billing_period_alignment | any <varchar> (Billing Period Alignment) The billing period alignment of the plan price. |
usage_records_rating_option | any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price. |
billing_period_id | any <int> (Billing Period) The identifier of the billing period associated with the plan price. |
billing_period_months_weeks | any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price. |
billing_month_id | any <int> (Billing Month) The identifier of the billing month associated with the plan price. |
billing_day_type_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
billing_week_day_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
created_at | any <timestamp> (Created At) The date and time when the plan price was created. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan price. |
data_source | any <char> (Data Source) The data source of the plan price. |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns PlanPrice data
plan-price required | char PlanPrice id |
id | any <varchar> (Id) The unique identifier for the plan price. |
plan_id | any <int> (Plan Id) The identifier of the plan associated with the plan price. |
product_id | any <int> (Product Id) The identifier of the product associated with the plan price. |
name | any <int> (Name) The name of the plan price. |
description | any <varchar> (Description) The description of the plan price. |
category | any <date> (Category) The category of the plan price. |
charge_model | any <varchar> (Charge Model) The charge model of the plan price. Possible values:
|
accounting_account_code | any <varchar> (Account) The accounting account code of the plan price. |
list_price | any <double> (List Price) The list price of the plan price. |
list_price_base | any <varchar> (List Price Base) The list price base of the plan price. |
uom | any <varchar> (UOM) The unit of measure (UOM) of the plan price. |
included_units | any <varchar> (Included Units) The included units of the plan price. |
default_quantity | any <varchar> (Default Quantity) The default quantity of the plan price. |
trigger_condition | any <varchar> (Trigger Condition) The trigger condition of the plan price. |
end_date | any <varchar> (End Date) The end date of the plan price. |
billing_timming | any <varchar> (Billing Timming) The billing timming of the plan price. Possible values:
|
billing_period_alignment | any <varchar> (Billing Period Alignment) The billing period alignment of the plan price. |
usage_records_rating_option | any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price. |
billing_period_id | any <int> (Billing Period) The identifier of the billing period associated with the plan price. |
billing_period_months_weeks | any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price. |
billing_month_id | any <int> (Billing Month) The identifier of the billing month associated with the plan price. |
billing_day_type_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
billing_week_day_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
created_at | any <timestamp> (Created At) The date and time when the plan price was created. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan price. |
data_source | any <char> (Data Source) The data source of the plan price. |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns updated PlanPrice data
plan-price required | char PlanPrice id |
id | any <varchar> (Id) The unique identifier for the plan price. |
plan_id | any <int> (Plan Id) The identifier of the plan associated with the plan price. |
product_id | any <int> (Product Id) The identifier of the product associated with the plan price. |
name | any <int> (Name) The name of the plan price. |
description | any <varchar> (Description) The description of the plan price. |
category | any <date> (Category) The category of the plan price. |
charge_model | any <varchar> (Charge Model) The charge model of the plan price. Possible values:
|
accounting_account_code | any <varchar> (Account) The accounting account code of the plan price. |
list_price | any <double> (List Price) The list price of the plan price. |
list_price_base | any <varchar> (List Price Base) The list price base of the plan price. |
uom | any <varchar> (UOM) The unit of measure (UOM) of the plan price. |
included_units | any <varchar> (Included Units) The included units of the plan price. |
default_quantity | any <varchar> (Default Quantity) The default quantity of the plan price. |
trigger_condition | any <varchar> (Trigger Condition) The trigger condition of the plan price. |
end_date | any <varchar> (End Date) The end date of the plan price. |
billing_timming | any <varchar> (Billing Timming) The billing timming of the plan price. Possible values:
|
billing_period_alignment | any <varchar> (Billing Period Alignment) The billing period alignment of the plan price. |
usage_records_rating_option | any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price. |
billing_period_id | any <int> (Billing Period) The identifier of the billing period associated with the plan price. |
billing_period_months_weeks | any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price. |
billing_month_id | any <int> (Billing Month) The identifier of the billing month associated with the plan price. |
billing_day_type_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
billing_week_day_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
created_at | any <timestamp> (Created At) The date and time when the plan price was created. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan price. |
data_source | any <char> (Data Source) The data source of the plan price. |
id | any <varchar> (Id) The unique identifier for the plan price. |
plan_id | any <int> (Plan Id) The identifier of the plan associated with the plan price. |
product_id | any <int> (Product Id) The identifier of the product associated with the plan price. |
name | any <int> (Name) The name of the plan price. |
description | any <varchar> (Description) The description of the plan price. |
category | any <date> (Category) The category of the plan price. |
charge_model | any <varchar> (Charge Model) The charge model of the plan price. Possible values:
|
accounting_account_code | any <varchar> (Account) The accounting account code of the plan price. |
list_price | any <double> (List Price) The list price of the plan price. |
list_price_base | any <varchar> (List Price Base) The list price base of the plan price. |
uom | any <varchar> (UOM) The unit of measure (UOM) of the plan price. |
included_units | any <varchar> (Included Units) The included units of the plan price. |
default_quantity | any <varchar> (Default Quantity) The default quantity of the plan price. |
trigger_condition | any <varchar> (Trigger Condition) The trigger condition of the plan price. |
end_date | any <varchar> (End Date) The end date of the plan price. |
billing_timming | any <varchar> (Billing Timming) The billing timming of the plan price. Possible values:
|
billing_period_alignment | any <varchar> (Billing Period Alignment) The billing period alignment of the plan price. |
usage_records_rating_option | any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price. |
billing_period_id | any <int> (Billing Period) The identifier of the billing period associated with the plan price. |
billing_period_months_weeks | any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price. |
billing_month_id | any <int> (Billing Month) The identifier of the billing month associated with the plan price. |
billing_day_type_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
billing_week_day_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
created_at | any <timestamp> (Created At) The date and time when the plan price was created. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan price. |
data_source | any <char> (Data Source) The data source of the plan price. |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Deletes a record and returns deleted record
plan-price required | char PlanPrice id |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of PlanPrice with all foreign keys
id | any <varchar> (Id) The unique identifier for the plan price. |
plan_id | any <int> (Plan Id) The identifier of the plan associated with the plan price. |
product_id | any <int> (Product Id) The identifier of the product associated with the plan price. |
name | any <int> (Name) The name of the plan price. |
description | any <varchar> (Description) The description of the plan price. |
category | any <date> (Category) The category of the plan price. |
charge_model | any <varchar> (Charge Model) The charge model of the plan price. Possible values:
|
accounting_account_code | any <varchar> (Account) The accounting account code of the plan price. |
list_price | any <double> (List Price) The list price of the plan price. |
list_price_base | any <varchar> (List Price Base) The list price base of the plan price. |
uom | any <varchar> (UOM) The unit of measure (UOM) of the plan price. |
included_units | any <varchar> (Included Units) The included units of the plan price. |
default_quantity | any <varchar> (Default Quantity) The default quantity of the plan price. |
trigger_condition | any <varchar> (Trigger Condition) The trigger condition of the plan price. |
end_date | any <varchar> (End Date) The end date of the plan price. |
billing_timming | any <varchar> (Billing Timming) The billing timming of the plan price. Possible values:
|
billing_period_alignment | any <varchar> (Billing Period Alignment) The billing period alignment of the plan price. |
usage_records_rating_option | any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price. |
billing_period_id | any <int> (Billing Period) The identifier of the billing period associated with the plan price. |
billing_period_months_weeks | any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price. |
billing_month_id | any <int> (Billing Month) The identifier of the billing month associated with the plan price. |
billing_day_type_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
billing_week_day_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
created_at | any <timestamp> (Created At) The date and time when the plan price was created. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan price. |
data_source | any <char> (Data Source) The data source of the plan price. |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns list of PlanPrice with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <varchar> (Id) The unique identifier for the plan price. |
plan_id | any <int> (Plan Id) The identifier of the plan associated with the plan price. |
product_id | any <int> (Product Id) The identifier of the product associated with the plan price. |
name | any <int> (Name) The name of the plan price. |
description | any <varchar> (Description) The description of the plan price. |
category | any <date> (Category) The category of the plan price. |
charge_model | any <varchar> (Charge Model) The charge model of the plan price. Possible values:
|
accounting_account_code | any <varchar> (Account) The accounting account code of the plan price. |
list_price | any <double> (List Price) The list price of the plan price. |
list_price_base | any <varchar> (List Price Base) The list price base of the plan price. |
uom | any <varchar> (UOM) The unit of measure (UOM) of the plan price. |
included_units | any <varchar> (Included Units) The included units of the plan price. |
default_quantity | any <varchar> (Default Quantity) The default quantity of the plan price. |
trigger_condition | any <varchar> (Trigger Condition) The trigger condition of the plan price. |
end_date | any <varchar> (End Date) The end date of the plan price. |
billing_timming | any <varchar> (Billing Timming) The billing timming of the plan price. Possible values:
|
billing_period_alignment | any <varchar> (Billing Period Alignment) The billing period alignment of the plan price. |
usage_records_rating_option | any <varchar> (Usage Records Rating Option) The usage records rating option of the plan price. |
billing_period_id | any <int> (Billing Period) The identifier of the billing period associated with the plan price. |
billing_period_months_weeks | any <int> (Billing Period Months Weeks) The billing period months weeks of the plan price. |
billing_month_id | any <int> (Billing Month) The identifier of the billing month associated with the plan price. |
billing_day_type_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
billing_week_day_id | any <int> (Billing Day) The identifier of the billing day associated with the plan price. |
created_at | any <timestamp> (Created At) The date and time when the plan price was created. |
assigned_to | any <char> (Assigned To) The user who is assigned to the plan price. |
data_source | any <char> (Data Source) The data source of the plan price. |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns filtered PlanPrice data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
Returns deleted PlanPrice data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__pp3VnHhSBWl7eY2bl",
- "plan_id": 1,
- "product_id": 1,
- "name": 1,
- "description": "Plan 1 description",
- "category": "2020-01-01",
- "charge_model": "flat_fee",
- "accounting_account_code": "12345",
- "list_price": 100,
- "list_price_base": "USD",
- "uom": "each",
- "included_units": "1",
- "default_quantity": "1",
- "trigger_condition": "1",
- "end_date": "2020-01-01",
- "billing_timming": "in_advance",
- "billing_period_alignment": "1",
- "usage_records_rating_option": "1",
- "billing_period_id": 1,
- "billing_period_months_weeks": 1,
- "billing_month_id": 1,
- "billing_day_type_id": 1,
- "billing_week_day_id": 1,
- "created_at": "2020-01-01T00:00:00Z",
- "assigned_to": "__test__us3VnHhSBWl7eY2bl",
- "data_source": "__test__ds3VnHhSBWl7eY2bl"
}
A user is a person who can access your SubscriptionFlow instance. The user details include the user ID, email, first name, last name, role, status, address information, and locale.
Returns list of Users
id | any <varchar> (Id) A unique and immutable identifier for the user. |
any <varchar> (Email) The email address of the user. | |
user_type | any <varchar> (User Type) The type of the user. Possible values are
|
first_name | any <varchar> (First Name) The first name of the user. |
last_name | any <varchar> (Last Name) The last name of the user. |
nationality | any <varchar> (Nationality) The nationality of the user. |
username | any <varchar> (Username) The username of the user. |
status | any <varchar> (Status) The status of the user. Possible values are
|
designation_id | any <varchar> (Designation Id) The identifier of the designation associated with the user. |
alias | any <varchar> (Alias) The alias of the user. |
phone | any <varchar> (Phone) The phone number of the user. |
mobile | any <varchar> (Mobile) The mobile number of the user. |
website | any <varchar> (Website) The website of the user. |
fax | any <varchar> (Fax) The fax number of the user. |
date_of_birth | any <varchar> (Date Of Birth) The date of birth of the user. |
street | any <varchar> (Street) The street address of the user. |
city | any <varchar> (City) The city of the user. |
state | any <varchar> (State) The state of the user. |
zip_code | any <varchar> (Zip Code) The zip code of the user. |
country | any <varchar> (Country) The country of the user. |
time_format | any <varchar> (Time Format) The time format of the user. |
timezone | any <varchar> (Timezone) The timezone of the user. |
signature | any <varchar> (Signature) The signature of the user. |
data_source | any <char> (Data Source) The source of data for the user. |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Returns User data
id | any <varchar> (Id) A unique and immutable identifier for the user. |
any <varchar> (Email) The email address of the user. | |
user_type | any <varchar> (User Type) The type of the user. Possible values are
|
first_name | any <varchar> (First Name) The first name of the user. |
last_name | any <varchar> (Last Name) The last name of the user. |
nationality | any <varchar> (Nationality) The nationality of the user. |
username | any <varchar> (Username) The username of the user. |
status | any <varchar> (Status) The status of the user. Possible values are
|
designation_id | any <varchar> (Designation Id) The identifier of the designation associated with the user. |
alias | any <varchar> (Alias) The alias of the user. |
phone | any <varchar> (Phone) The phone number of the user. |
mobile | any <varchar> (Mobile) The mobile number of the user. |
website | any <varchar> (Website) The website of the user. |
fax | any <varchar> (Fax) The fax number of the user. |
date_of_birth | any <varchar> (Date Of Birth) The date of birth of the user. |
street | any <varchar> (Street) The street address of the user. |
city | any <varchar> (City) The city of the user. |
state | any <varchar> (State) The state of the user. |
zip_code | any <varchar> (Zip Code) The zip code of the user. |
country | any <varchar> (Country) The country of the user. |
time_format | any <varchar> (Time Format) The time format of the user. |
timezone | any <varchar> (Timezone) The timezone of the user. |
signature | any <varchar> (Signature) The signature of the user. |
data_source | any <char> (Data Source) The source of data for the user. |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Returns User data
user required | char User id |
id | any <varchar> (Id) A unique and immutable identifier for the user. |
any <varchar> (Email) The email address of the user. | |
user_type | any <varchar> (User Type) The type of the user. Possible values are
|
first_name | any <varchar> (First Name) The first name of the user. |
last_name | any <varchar> (Last Name) The last name of the user. |
nationality | any <varchar> (Nationality) The nationality of the user. |
username | any <varchar> (Username) The username of the user. |
status | any <varchar> (Status) The status of the user. Possible values are
|
designation_id | any <varchar> (Designation Id) The identifier of the designation associated with the user. |
alias | any <varchar> (Alias) The alias of the user. |
phone | any <varchar> (Phone) The phone number of the user. |
mobile | any <varchar> (Mobile) The mobile number of the user. |
website | any <varchar> (Website) The website of the user. |
fax | any <varchar> (Fax) The fax number of the user. |
date_of_birth | any <varchar> (Date Of Birth) The date of birth of the user. |
street | any <varchar> (Street) The street address of the user. |
city | any <varchar> (City) The city of the user. |
state | any <varchar> (State) The state of the user. |
zip_code | any <varchar> (Zip Code) The zip code of the user. |
country | any <varchar> (Country) The country of the user. |
time_format | any <varchar> (Time Format) The time format of the user. |
timezone | any <varchar> (Timezone) The timezone of the user. |
signature | any <varchar> (Signature) The signature of the user. |
data_source | any <char> (Data Source) The source of data for the user. |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Returns updated User data
user required | char User id |
id | any <varchar> (Id) A unique and immutable identifier for the user. |
any <varchar> (Email) The email address of the user. | |
user_type | any <varchar> (User Type) The type of the user. Possible values are
|
first_name | any <varchar> (First Name) The first name of the user. |
last_name | any <varchar> (Last Name) The last name of the user. |
nationality | any <varchar> (Nationality) The nationality of the user. |
username | any <varchar> (Username) The username of the user. |
status | any <varchar> (Status) The status of the user. Possible values are
|
designation_id | any <varchar> (Designation Id) The identifier of the designation associated with the user. |
alias | any <varchar> (Alias) The alias of the user. |
phone | any <varchar> (Phone) The phone number of the user. |
mobile | any <varchar> (Mobile) The mobile number of the user. |
website | any <varchar> (Website) The website of the user. |
fax | any <varchar> (Fax) The fax number of the user. |
date_of_birth | any <varchar> (Date Of Birth) The date of birth of the user. |
street | any <varchar> (Street) The street address of the user. |
city | any <varchar> (City) The city of the user. |
state | any <varchar> (State) The state of the user. |
zip_code | any <varchar> (Zip Code) The zip code of the user. |
country | any <varchar> (Country) The country of the user. |
time_format | any <varchar> (Time Format) The time format of the user. |
timezone | any <varchar> (Timezone) The timezone of the user. |
signature | any <varchar> (Signature) The signature of the user. |
data_source | any <char> (Data Source) The source of data for the user. |
id | any <varchar> (Id) A unique and immutable identifier for the user. |
any <varchar> (Email) The email address of the user. | |
user_type | any <varchar> (User Type) The type of the user. Possible values are
|
first_name | any <varchar> (First Name) The first name of the user. |
last_name | any <varchar> (Last Name) The last name of the user. |
nationality | any <varchar> (Nationality) The nationality of the user. |
username | any <varchar> (Username) The username of the user. |
status | any <varchar> (Status) The status of the user. Possible values are
|
designation_id | any <varchar> (Designation Id) The identifier of the designation associated with the user. |
alias | any <varchar> (Alias) The alias of the user. |
phone | any <varchar> (Phone) The phone number of the user. |
mobile | any <varchar> (Mobile) The mobile number of the user. |
website | any <varchar> (Website) The website of the user. |
fax | any <varchar> (Fax) The fax number of the user. |
date_of_birth | any <varchar> (Date Of Birth) The date of birth of the user. |
street | any <varchar> (Street) The street address of the user. |
city | any <varchar> (City) The city of the user. |
state | any <varchar> (State) The state of the user. |
zip_code | any <varchar> (Zip Code) The zip code of the user. |
country | any <varchar> (Country) The country of the user. |
time_format | any <varchar> (Time Format) The time format of the user. |
timezone | any <varchar> (Timezone) The timezone of the user. |
signature | any <varchar> (Signature) The signature of the user. |
data_source | any <char> (Data Source) The source of data for the user. |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Deletes a record and returns deleted record
user required | char User id |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Returns list of Users with all foreign keys
id | any <varchar> (Id) A unique and immutable identifier for the user. |
any <varchar> (Email) The email address of the user. | |
user_type | any <varchar> (User Type) The type of the user. Possible values are
|
first_name | any <varchar> (First Name) The first name of the user. |
last_name | any <varchar> (Last Name) The last name of the user. |
nationality | any <varchar> (Nationality) The nationality of the user. |
username | any <varchar> (Username) The username of the user. |
status | any <varchar> (Status) The status of the user. Possible values are
|
designation_id | any <varchar> (Designation Id) The identifier of the designation associated with the user. |
alias | any <varchar> (Alias) The alias of the user. |
phone | any <varchar> (Phone) The phone number of the user. |
mobile | any <varchar> (Mobile) The mobile number of the user. |
website | any <varchar> (Website) The website of the user. |
fax | any <varchar> (Fax) The fax number of the user. |
date_of_birth | any <varchar> (Date Of Birth) The date of birth of the user. |
street | any <varchar> (Street) The street address of the user. |
city | any <varchar> (City) The city of the user. |
state | any <varchar> (State) The state of the user. |
zip_code | any <varchar> (Zip Code) The zip code of the user. |
country | any <varchar> (Country) The country of the user. |
time_format | any <varchar> (Time Format) The time format of the user. |
timezone | any <varchar> (Timezone) The timezone of the user. |
signature | any <varchar> (Signature) The signature of the user. |
data_source | any <char> (Data Source) The source of data for the user. |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Returns list of Users with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <varchar> (Id) A unique and immutable identifier for the user. |
any <varchar> (Email) The email address of the user. | |
user_type | any <varchar> (User Type) The type of the user. Possible values are
|
first_name | any <varchar> (First Name) The first name of the user. |
last_name | any <varchar> (Last Name) The last name of the user. |
nationality | any <varchar> (Nationality) The nationality of the user. |
username | any <varchar> (Username) The username of the user. |
status | any <varchar> (Status) The status of the user. Possible values are
|
designation_id | any <varchar> (Designation Id) The identifier of the designation associated with the user. |
alias | any <varchar> (Alias) The alias of the user. |
phone | any <varchar> (Phone) The phone number of the user. |
mobile | any <varchar> (Mobile) The mobile number of the user. |
website | any <varchar> (Website) The website of the user. |
fax | any <varchar> (Fax) The fax number of the user. |
date_of_birth | any <varchar> (Date Of Birth) The date of birth of the user. |
street | any <varchar> (Street) The street address of the user. |
city | any <varchar> (City) The city of the user. |
state | any <varchar> (State) The state of the user. |
zip_code | any <varchar> (Zip Code) The zip code of the user. |
country | any <varchar> (Country) The country of the user. |
time_format | any <varchar> (Time Format) The time format of the user. |
timezone | any <varchar> (Timezone) The timezone of the user. |
signature | any <varchar> (Signature) The signature of the user. |
data_source | any <char> (Data Source) The source of data for the user. |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Returns filtered User data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
Returns deleted Users data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__sf5sukSOXduqmOY",
- "user_type": "1",
- "first_name": "John",
- "last_name": "Doe",
- "nationality": "US",
- "username": "johndoe",
- "status": "1",
- "designation_id": "__test__sf5sukSOXduqmOY",
- "alias": "johndoe",
- "phone": "1234567890",
- "mobile": "1234567890",
- "website": "www.test.com",
- "fax": "1234567890",
- "date_of_birth": "2000-11-01",
- "street": "123 Main St",
- "city": "New York",
- "state": "New York",
- "zip_code": "12345",
- "country": "US",
- "time_format": "12",
- "timezone": "America/New_York",
- "signature": "John Doe",
- "data_source": "System"
}
A credit note is a document that itemizes a customer's credit for products and services. It is generated at the end of a billing cycle, which can be monthly, quarterly, or yearly. The credit note details include the credit note ID, name, customer ID, credit note date, due date, total amount, and status.
Possible values for credit note status are
Returns list of CreditNotes
id | any <char> (Id) The unique identifier for the credit note. |
name | any <varchar> (Name) The name of the credit note. |
amount | any <double> (Amount) The amount of the credit note. |
balance | any <varchar> (Balance) The balance of the credit note. |
status | any <varchar> (Status) The status of the credit note. Possible values are:
|
reference | any <varchar> (Reference) The reference of the credit note. |
created_at | any <timestamp> (Created At) The date and time when the credit note was created. |
updated_at | any <timestamp> (Updated At) The date and time when the credit note was last updated. |
created_by | any <char> (Created By) The user who created the credit note. |
updated_by | any <char> (Updated By) The user who last updated the credit note. |
assigned_to | any <char> (Assigned To) The user who the credit note is assigned to. |
data_source | any <char> (Data Source) The data source of the credit note. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns CreditNote data
id | any <char> (Id) The unique identifier for the credit note. |
name | any <varchar> (Name) The name of the credit note. |
amount | any <double> (Amount) The amount of the credit note. |
balance | any <varchar> (Balance) The balance of the credit note. |
status | any <varchar> (Status) The status of the credit note. Possible values are:
|
reference | any <varchar> (Reference) The reference of the credit note. |
created_at | any <timestamp> (Created At) The date and time when the credit note was created. |
updated_at | any <timestamp> (Updated At) The date and time when the credit note was last updated. |
created_by | any <char> (Created By) The user who created the credit note. |
updated_by | any <char> (Updated By) The user who last updated the credit note. |
assigned_to | any <char> (Assigned To) The user who the credit note is assigned to. |
data_source | any <char> (Data Source) The data source of the credit note. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns CreditNote data
credit-note required | char CreditNote id |
id | any <char> (Id) The unique identifier for the credit note. |
name | any <varchar> (Name) The name of the credit note. |
amount | any <double> (Amount) The amount of the credit note. |
balance | any <varchar> (Balance) The balance of the credit note. |
status | any <varchar> (Status) The status of the credit note. Possible values are:
|
reference | any <varchar> (Reference) The reference of the credit note. |
created_at | any <timestamp> (Created At) The date and time when the credit note was created. |
updated_at | any <timestamp> (Updated At) The date and time when the credit note was last updated. |
created_by | any <char> (Created By) The user who created the credit note. |
updated_by | any <char> (Updated By) The user who last updated the credit note. |
assigned_to | any <char> (Assigned To) The user who the credit note is assigned to. |
data_source | any <char> (Data Source) The data source of the credit note. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns updated CreditNote data
credit-note required | char CreditNote id |
id | any <char> (Id) The unique identifier for the credit note. |
name | any <varchar> (Name) The name of the credit note. |
amount | any <double> (Amount) The amount of the credit note. |
balance | any <varchar> (Balance) The balance of the credit note. |
status | any <varchar> (Status) The status of the credit note. Possible values are:
|
reference | any <varchar> (Reference) The reference of the credit note. |
created_at | any <timestamp> (Created At) The date and time when the credit note was created. |
updated_at | any <timestamp> (Updated At) The date and time when the credit note was last updated. |
created_by | any <char> (Created By) The user who created the credit note. |
updated_by | any <char> (Updated By) The user who last updated the credit note. |
assigned_to | any <char> (Assigned To) The user who the credit note is assigned to. |
data_source | any <char> (Data Source) The data source of the credit note. |
id | any <char> (Id) The unique identifier for the credit note. |
name | any <varchar> (Name) The name of the credit note. |
amount | any <double> (Amount) The amount of the credit note. |
balance | any <varchar> (Balance) The balance of the credit note. |
status | any <varchar> (Status) The status of the credit note. Possible values are:
|
reference | any <varchar> (Reference) The reference of the credit note. |
created_at | any <timestamp> (Created At) The date and time when the credit note was created. |
updated_at | any <timestamp> (Updated At) The date and time when the credit note was last updated. |
created_by | any <char> (Created By) The user who created the credit note. |
updated_by | any <char> (Updated By) The user who last updated the credit note. |
assigned_to | any <char> (Assigned To) The user who the credit note is assigned to. |
data_source | any <char> (Data Source) The data source of the credit note. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Deletes a record and returns deleted record
credit-note required | char CreditNote id |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns list of CreditNotes with all foreign keys
id | any <char> (Id) The unique identifier for the credit note. |
name | any <varchar> (Name) The name of the credit note. |
amount | any <double> (Amount) The amount of the credit note. |
balance | any <varchar> (Balance) The balance of the credit note. |
status | any <varchar> (Status) The status of the credit note. Possible values are:
|
reference | any <varchar> (Reference) The reference of the credit note. |
created_at | any <timestamp> (Created At) The date and time when the credit note was created. |
updated_at | any <timestamp> (Updated At) The date and time when the credit note was last updated. |
created_by | any <char> (Created By) The user who created the credit note. |
updated_by | any <char> (Updated By) The user who last updated the credit note. |
assigned_to | any <char> (Assigned To) The user who the credit note is assigned to. |
data_source | any <char> (Data Source) The data source of the credit note. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns list of CreditNotes with quick filters
fieldName required | varchar Field name to apply filter E.g. 'name' = 'John' |
id | any <char> (Id) The unique identifier for the credit note. |
name | any <varchar> (Name) The name of the credit note. |
amount | any <double> (Amount) The amount of the credit note. |
balance | any <varchar> (Balance) The balance of the credit note. |
status | any <varchar> (Status) The status of the credit note. Possible values are:
|
reference | any <varchar> (Reference) The reference of the credit note. |
created_at | any <timestamp> (Created At) The date and time when the credit note was created. |
updated_at | any <timestamp> (Updated At) The date and time when the credit note was last updated. |
created_by | any <char> (Created By) The user who created the credit note. |
updated_by | any <char> (Updated By) The user who last updated the credit note. |
assigned_to | any <char> (Assigned To) The user who the credit note is assigned to. |
data_source | any <char> (Data Source) The data source of the credit note. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns filtered CreditNote data
$equals | varchar Equals field-value. E.g. filter[column_name][$equals] = 'some_value' |
$not_equals | varchar Unequals field-value. E.g. filter[column_name][$not_equals] = 'some_value' |
$starts | varchar Match value starts with. E.g. filter[column_name][$starts] = 'some_value' |
$ends | varchar Match value ends with. E.g. filter[column_name][$ends] = 'some_value' |
$contains | varchar Match if field contains value. E.g. filter[column_name][$contains] = 'some_value' |
$in | varchar Match if field match any value in array. E.g. filter[column_name][$in] = ['first','second'] |
$is_null | varchar Match if field have null value. E.g. filter[column_name][$is_null] = true |
$not_null | varchar Match if field is not null. E.g. filter[column_name][$not_null] = true |
$not_in | varchar Match if field does not match any value in array. E.g. filter[column_name][$not_in] = ['first','second'] |
$lt | varchar Match if field value is lesser than given value E.g. filter[column_name][$lt] = 'some_value' |
$lte | varchar Match if field value is lesser than or equals to given value E.g. filter[column_name][$lte] = 'some_value' |
$gt | varchar Match if field value is greater than given value E.g. filter[column_name][$gt] = 'some_value' |
$gte | varchar Match if field value is greater than or equals to given value E.g. filter[column_name][$gte] = 'some_value' |
$sortorder | varchar Sort results asc/desc E.g. filter[$sortorder] = 'asc|desc' |
$limit | varchar Limit results E.g. filter[$limit] = '50' | For offset: filter[$offset] = '20' |
$paginate | varchar Paginate results E.g. filter[$paginate] = '50 |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}
Returns deleted CreditNotes data
ids required | varchar Array of ids to be deleted. |
{- "id": "__test__cs3VnHhSBWl7eY2bl",
- "name": "Acme Corp",
- "amount": 100,
- "balance": "100.00",
- "status": "Unallocated",
- "reference": "12345",
- "created_at": "2020-01-01T00:00:00Z",
- "updated_at": "2020-01-01T00:00:00Z",
- "created_by": "__test__cs3VnHhSBWl7eY2bl",
- "updated_by": "__test__cs3VnHhSBWl7eY2bl",
- "assigned_to": "__test__cs3VnHhSBWl7eY2bl",
- "data_source": "__test__cs3VnHhSBWl7eY2bl"
}