Service Charges
Create Service Charge
Create a service charge on your account
POST https://api.zenstrin.com/serviceCharges
Request Body
name*
string
The name of the service charge
description
string
The description of the service charge
id
string
The ID of the service charge. The id parameter represents the unique identifier of a document in the database. Must be a non-empty string. Must not contain any of the following characters: '/', '.', '*', '[', ']', '(', ')'. Must be less than or equal to 1,500 bytes when UTF-8 encoded.
amount*
integer
The amount you are charging
frequency
string
The frequency of the service charge. Available options include: ["one time", "daily", "weekly", "monthly", "every 3 months", "every 4 months", "every 6 months", "annually"]. Defaults to "one time".
List Service Charges
List all service charges on your account
GET https://api.zenstrin.com/serviceCharges
Fetch Service Charge
Get the details of a service charge on your account
GET https://api.zenstrin.com/serviceCharges/:serviceChargeId
Path Parameters
serviceCharge*
String
The ID of the service charge
Update Service Charge
Update a service charge on your account
PATCH https://api.zenstrin.com/serviceCharges/:serviceChargeId
Path Parameters
serviceChargeId*
string
The ID of the service charge
Request Body
name
string
The name of the service charge
amount
integer
The amount you are charging
description
string
The description of the service charge
frequency
array
The frequency of the service charge. Available options include: ["one time", "daily", "weekly", "monthly", "every 3 months", "every 4 months", "every 6 months", "annually"]. Defaults to "one time".
Last updated