Reminders

Reminder object

Attributes

invoice string

Unique identifier of the invoice which is the reason for this reminder.

payment string

Unique identifier of the payment which is the reason for this reminder.

order string

Unique identifier of the order which is the reason for this reminder.

credit_note string

Unique identifier of the credit note which is the reason for this reminder.

recipient list

An email list of the receptionists for this reminder.

action string

The action that the message should include. It can have the value of pay

message text

A body of the message for this reminder.

subject string

A subject for this reminder.

user string

Email of the user that created this reminder. read only

created datetime

Date and time of the creation of this reminder. read only

Create a reminder

POST https://api.piriod.com/reminders/messages/

Creates a new Reminder object.

Request Body

Name
Type
Description

invoice

string

Unique identifier of the invoice which is the reason for this reminder.

recipient

array

An email list of the receptionists for this reminder.

message

string

A body of the message for this reminder.

subject

string

A subject for this reminder.

{
    "subject": "Invoice Nº AX783L",
    "recipient": [
      "[email protected]",
      "[email protected]"
    ],
    "message": "Dear Acme Inc team, this is a new invoice for our services from March",
    "created": "2021-02-04T05:01:28.721769-04:00",
    "invoice": "inv_oX4AZA1z9S2CAx4wPm",
    "credit_note": null,
    "payment": null,
    "order": null,
    "user": "[email protected]"
}

List reminders

GET https://api.piriod.com/reminders/messages/

Lists Reminder objects. The query parameter are compatible with filter operators. Learn more about pagination and filtering.

Query Parameters

Name
Type
Description

invoice

string

Unique identifier of the invoice to filter the reminders list by invoice.

payment

string

Unique identifier of the payment to filter the reminders list by payment.

order

string

Unique identifier of the payment to filter the reminders list by order.

credit_note

string

Unique identifier of the payment to filter the reminders list by credit note.

[
    {
        "subject": "Invoice Nº AX783L",
        "recipient": [
          "[email protected]",
          "[email protected]"
        ],
        "message": "Dear Acme Inc team, this is a new invoice for our services from March",
        "created": "2021-02-04T05:01:28.721769-04:00",
        "invoice": "inv_oX4AZA1z9S2CAx4wPm",
        "credit_note": null,
        "payment": null,
        "order": null,
        "user": "[email protected]"
    },
    {
        "subject": "Invoice Nº AX827L",
        "recipient": [
          "[email protected]",
          "[email protected]"
        ],
        "message": "Dear Acme Inc team, this is a new invoice for our services from March",
        "created": "2021-02-04T05:01:28.721769-04:00",
        "invoice": "inv_px4AKa7Q9Q2cLz4XQs",
        "credit_note": null,
        "payment": null,
        "order": null,
        "user": "[email protected]"
    }
]

Last updated

Was this helpful?