Contact Invoices API - FI

Tämän API:n avulla voit tarkastella, luoda, etsiä ja luoda tilejä valitulle asiakkaalle.

Lukeminen.

Voit tarkastella valitun yhteyshenkilön luotuja tilejä projektissa.

GET https://api.smartsender.com/v1/contacts/{contactId}/invoices

Pääparametrit:

Nimi	Kuvaus	Validointi

Nimi	Kuvaus	Validointi
page	Pyydetty sivu	Vähimmäisarvo 1
limitation	Näytettävien tietojen määrä sivua kohden	Pienin arvo 1, maksimi 20

Jos vastaus on onnistunut, saat seuraavat tiedot:

{
    "cursor": Cursor,
    "collection": Invoice[]
}

Vastauksen kuvaus:

Nimi	Kuvaus

Nimi	Kuvaus
cursor	Cursor esine
collection	joukko esineitä Invoice

Kuitti tilinumerolla.

Yhteyshenkilön laskun hakeminen numerolla (orderId).

GET https://api.smartsender.com/v1/contacts/{contactId}/invoices/{orderId}

Jos vastaus on onnistunut, hanki tyyppinen objekti Invoice.

Tilin luominen.

Luo yhteyshenkilölle uusi tili.

POST https://api.smartsender.com/v1/contacts/{contactId}/invoices

Pääparametrit:

Nimi	Kuvaus

Nimi	Kuvaus
essenceId	Tuotetunnus
paymentSystemId	Maksujärjestelmän tunniste

Jos vastaus on onnistunut, hanki tyyppinen objekti Invoice.

Maksulasku (manuaalinen maksu).

Maksaa määritetyn laskun (tai luo sellaisen, jos sitä ei vielä ollut) määritetylle yhteyshenkilölle. Jos maksusumma on pienempi kuin laskun todellinen summa, lasku on silti maksettu onnistuneesti.

PUT https://api.smartsender.com/v1/contacts/{contactId}/invoices

Pääparametrit:

Nimi	Kuvaus

Nimi	Kuvaus
date	Maksupäivä, muoto Y-m-d H:i:s
amount	Maksun määrä
currency	Maksuvaluutta (pieni kirjain)
orderId	tilausnumero
essenceId	Tuotetunnus
paymentSystemId	Maksujärjestelmän tunniste

Jos vastaus on onnistunut, hanki tyyppinen objekti Invoice.