Contact Invoices API - en
- Yulia Zatsarinnaya Smart Sender
With this API, you can view, create, find and create accounts for the selected customer.
Reading.
Allows you to view the created accounts of the selected contact in the project.
GET https://api.smartsender.com/v1/contacts/{contactId}/invoices
Main parameters:
Name | Description | Validation |
|---|---|---|
page | Requested Page | Minimum value 1 |
limitation | Amount of data to display per page | Minimum value 1, maximum 20 |
In case of a successful response, you will receive the following:
{
"cursor": Cursor,
"collection": Invoice[]
}
Answer description:
Receipt by account number.
Getting the contact's invoice by number (orderId).
GET https://api.smartsender.com/v1/contacts/{contactId}/invoices/{orderId}
In case of a successful response, get an object of type Invoice.
Account creation.
Create a new account for a contact.
POST https://api.smartsender.com/v1/contacts/{contactId}/invoices
Main parameters:
Name | Description |
|---|---|
essenceId | Item ID |
paymentSystemId | Payment system identifier |
In case of a successful response, get an object of type Invoice.
Payment invoice (manual payment).
Pays the specified invoice (or creates one if it didn't already exist) for the specified contact. If the payment amount is less than the actual amount on the issued invoice, the invoice will still be successfully paid.
PUT https://api.smartsender.com/v1/contacts/{contactId}/invoices
Main parameters:
Name | Description |
|---|---|
date | Payment date, format Y-m-d H:i:s |
amount | Amount of payment |
currency | Payment currency (lowecase) |
orderId | Order ID |
essenceId | Item ID |
paymentSystemId | Payment system identifier |
In case of a successful response, get an object of type Invoice.