List credit notes

GET 
/v1/credit-notes

This endpoint allows you to retrieve a list of created credit notes.

Request

Query Parameters

page integer

Default value: 1

The page of results

per_page integer

Default value: 15

Maximum Number of results per page

status string

Possible values: [pending, active]

Filter the credit notes returned by its status.

insurer string

Filter the credit notes returned by insurer.

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
code string
The unique identifier for credit note
status string
Current status of the policy
premium number
The credit note premium
premium_due_date date
Date when premium will be due
current_date date
Date of creation
customer object
The the customer's information
ref stringrequired
Unique identifier for the customer on your system
email stringrequired
The customer's email address
phone string
first_name stringrequired
last_name stringrequired
insurer object
An insurance provider
code string
The unique code of the insurer
name string
The name of the insurer
logo_url string
A link to the Insurer's logo
terms_conditions string
Insurer's terms and conditions
product object
An individual insurance product or plan
title string
The name of the product
code string
The unique identifier for technical purposes
id integer
Unique Id of the product.
insurer object
An insurance provider
code string
The unique code of the insurer
name string
The name of the insurer
logo_url string
A link to the Insurer's logo
terms_conditions string
Insurer's terms and conditions
product type object
A major category of insurance e.g Health, Automobile, Life, Gadget, Goods in transit, etc
name string
The generally accepted human friendly name
slug string
The unique identifier for technical purposes
cover-benefits object
list of the nefits covered.
created-at string
Date of product creation
price integer
Price of product
premium-type string
Define the product premium tier.
premium-rate-unit integer
premium-rate number
premium number
partner-commision-rate number
min-premium string
premium-rules string
premium_frequency string
Possible values: [monthly, quarterly, annually]
Default value: annually
]
links object
first string
last string
prev string
next string

Example (from schema)

{
  "data": [
    {
      "code": "CN-34243TF",
      "status": "active",
      "premium": 800000,
      "premium_due_date": "2022-03-24",
      "current_date": "2022-03-24",
      "customer": {
        "ref": "string",
        "email": "string",
        "phone": "408-867-5309",
        "first_name": "Jane",
        "last_name": "Doe"
      },
      "insurer": {
        "code": "AXA",
        "name": "Axa Mansard",
        "logo_url": null,
        "terms_conditions": null
      },
      "product": {
        "title": "Comprehensive Car Plan XYZ",
        "code": "auto-com-xyz",
        "id": 1,
        "insurer": {
          "code": "AXA",
          "name": "Axa Mansard",
          "logo_url": null,
          "terms_conditions": null
        },
        "product type": {
          "name": "Goods in Transit",
          "slug": "GIT"
        },
        "cover-benefits": {},
        "created-at": "string",
        "price": 0,
        "premium-type": "string",
        "premium-rate-unit": 0,
        "premium-rate": 0,
        "premium": 0,
        "partner-commision-rate": 0,
        "min-premium": "string",
        "premium-rules": "string",
        "premium_frequency": "annually"
      }
    }
  ],
  "links": {
    "first": "https://api.grow.curacel.co/credit-notes?page=1",
    "last": "https://api.grow.curacel.co/credit-notes?page=3",
    "prev": "https://api.grow.curacel.co/credit-notes?page=1",
    "next": "https://api.grow.curacel.co/credit-notes?page=2"
  }
}

400

Bad request.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "400 Bad Request (Client Error)"
}

Loading...