Faktury kontaktowe API
Za pomocą tego interfejsu API można przeglądać, tworzyć, wyszukiwać i tworzyć faktury dla wybranego klienta.
Czytanie.
Umożliwia wyświetlenie utworzonych faktur wybranego kontaktu w projekcie.
GET https://api.smartsender.com/v1/contacts/{contactId}/invoices
Parametry podstawowe:
Tytuł | Opis | Walidacja |
---|---|---|
page | Żądana strona | Wartość minimalna 1 |
limitation | Ilość danych, które mają być wyświetlane na stronie | Wartość minimalna 1, wartość maksymalna 20 |
В случае успешного ответа получите следующее:
{
"cursor": Cursor,
"collection": Invoice[]
}
Opis odpowiedzi:
Odbiór według numeru konta.
Uzyskaj konto kontaktu według numeru (orderId).
GET https://api.smartsender.com/v1/contacts/{contactId}/invoices/{orderId}
Jeśli się powiedzie, otrzymasz obiekt typu Faktura.
Zakładanie konta.
Tworzenie nowego konta dla kontaktu.
Parametry podstawowe:
Tytuł | Opis |
---|---|
essenceId | Identyfikator produktu |
paymentSystemId | Identyfikator systemu płatności |
Jeśli się powiedzie, otrzymasz obiekt typu Faktura.
Zapłać za fakturę (płatność ręczna).
Opłaca podaną fakturę (lub tworzy ją, jeśli wcześniej nie istniała) dla podanego kontaktu. Jeśli kwota płatności jest niższa niż faktyczna kwota na fakturze, faktura zostanie pomyślnie opłacona.
Parametry podstawowe:
Tytuł | Opis |
---|---|
date | Data płatności, format Y-m-d H:i:s |
amount | Kwota płatności |
currency | Waluta płatności (małe litery) |
orderId | Identyfikator zamówienia |
essenceId | Identyfikator produktu |
paymentSystemId | Identyfikator systemu płatności |
Jeśli się powiedzie, otrzymasz obiekt typu Faktura.