",
"from_date": "2021-02-04",
"to_date": "2021-03-03",
"filter_by": "bill_date",
"invoice_status": "",
"customer_code": "",
"group": "",
"franchise_id": ""
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
{% endtab %}
{% endtabs %}
## Save subscription
`POST` `/api/v1/merchant/subscription/save`
This endpoint allows you to save recurring invoicing.
#### Request Body
| Name | Type | Description |
| ---------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| access\_key\_id | string | Your access key |
| secret\_access\_key | string | Your secret key. |
| template\_id | string | Invoice format encrypted key. |
| mode | string | Recurring mode (Monthly, Daily, Weekly, Yearly) |
| repeat\_every | number | Repeat every recurring mode eg. 3 Months |
| start\_date | string | Start date of invoice creation |
| due\_date | string | Due date of first invoice. |
| end\_mode | string | Recurring stop mode
Never: It will be infinite
Occurences: After occurrence subscription will end
End date: Set end date to stop subscription
|
| occurences | number | Set occurrence value if end mode is Occurrences |
| end\_date | string | Set end date if end mode is "End date" |
| carry\_forword\_dues | string | If you want to carry forward due of unpaid invoices |
| invoice | string | Invoice data. |
| customer\_code | string | Customer identifier. |
| bill\_cycle\_name | string | Billing cycle name eg. Feb 21 |
| bill\_date | string | Bill date (in the format of YYYY-mm-dd) |
| notify\_patron | number | Invoice notification to customer, 1 for enable |
| custom\_header\_fields | string | If you added custom fields in your invoice format you can set value for that column. |
| particular\_rows | string | Set values for particular rows as per your invoice format like Item name, Description, Cost |
| tax\_rows | string | Add taxes to invoice. |
| new\_customer | string | If customer does not exist in Swipez then you can add customer details. |
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
#### Sample code
{% tabs %}
{% tab title="CURL" %}
```
curl --location --request POST '/api/v1/merchant/subscription/save' \
--header 'Content-Type: application/json' \
--data-raw '{
"access_key_id": "",
"secret_access_key": "",
"template_id": "",
"mode": "Monthly",
"repeat_every": "3",
"start_date": "2021-03-01",
"due_date": "2021-03-07",
"end_mode": "Never",
"occurences": "",
"end_date": "",
"carry_forword_dues": "0",
"invoice":
{
"customer_code": "Cust-1",
"bill_cycle_name": "Feb 21",
"bill_date": "2021-02-01",
"due_date": "2021-02-05",
"invoice_properties": {
"notify_patron": "1"
},
"custom_header_fields": [
{
"id": "1853191",
"name": "Invoice no",
"type": "text",
"value": "INV-5"
}
],
"particular_rows": [
{
"item": "Product name",
"sac_code": "9899",
"description": "Product description",
"gst": "18",
"total_amount": "1500.00"
}
],
"tax_rows": [
{
"name": "IGST@18%",
"percentage": "18.00",
"applicable_on": "1500.00"
}
],
"new_customer": {
"customer_code": "",
"customer_name": "",
"email": "",
"mobile": "",
"address": "",
"city": "",
"state": "",
"zipcode": "",
"custom_fields": [
{
"id": "845",
"name": "GST",
"type": "gst",
"value": ""
}
]
}
}
}'
```
{% endtab %}
{% tab title="PHP" %}
```
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '/api/v1/merchant/subscription/save',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"access_key_id": "",
"secret_access_key": "",
"template_id": "",
"mode": "Monthly",
"repeat_every": "3",
"start_date": "2021-03-01",
"due_date": "2021-03-07",
"end_mode": "Never",
"occurences": "",
"end_date": "",
"carry_forword_dues": "0",
"invoice":
{
"customer_code": "Cust-1",
"bill_cycle_name": "Feb 21",
"bill_date": "2021-02-01",
"due_date": "2021-02-05",
"invoice_properties": {
"notify_patron": "1"
},
"custom_header_fields": [
{
"id": "1853191",
"name": "Invoice no",
"type": "text",
"value": "INV-5"
}
],
"particular_rows": [
{
"item": "Product name",
"sac_code": "9899",
"description": "Product description",
"gst": "18",
"total_amount": "1500.00"
}
],
"tax_rows": [
{
"name": "IGST@18%",
"percentage": "18.00",
"applicable_on": "1500.00"
}
],
"new_customer": {
"customer_code": "",
"customer_name": "",
"email": "",
"mobile": "",
"address": "",
"city": "",
"state": "",
"zipcode": "",
"custom_fields": [
{
"id": "845",
"name": "GST",
"type": "gst",
"value": ""
}
]
}
}
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
{% endtab %}
{% endtabs %}
## Delete invoice
`POST` `/api/v3/merchant/invoice/deleteInvoice`
This endpoint allows you to delete or cancel the invoice.
#### Request Body
| Name | Type | Description |
| ----------------------------------------------------- | ------ | ---------------------------------------------------------------- |
| access\_key\_id\* | String | Your access key |
| secret\_access\_key\* | String | Your secret key. |
| invoice\_id\* | String | System generated invoice id. |
| status\* | String | Filter by invoice status
(12-cancelled, 13-deleted)
|
{% tabs %}
{% tab title="200: OK " %}
```javascript
{
"reqtime": "2022-02-25 18:59:19",
"resptime": "2022-02-25 18:59:19",
"srvrsp": {
"invoice_id": "R000030213"
},
"errcode": 0,
"errmsg": "",
"errlist": null
}
```
{% endtab %}
{% endtabs %}
**Sample Code**
{% tabs %}
{% tab title="CURL" %}
```
curl --location --request POST '/api/v3/merchant/invoice/deleteInvoice' \
--header 'Content-Type: application/json' \
--data-raw '{
"access_key_id": "",
"secret_access_key": "",
"invoice_id": "",
"status": "12" //12 cancelled, 13 deleteted
}'
```
{% endtab %}
{% tab title="PHP" %}
```
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '/api/v3/merchant/invoice/deleteInvoice',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"access_key_id": "",
"secret_access_key": "",
"invoice_id": "",
"status": "12" //12 cancelled, 13 deleteted
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.swipez.in/invoicing.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.