Liite-rajapinnan resurssit
Liite-rajapinnan kautta voidaan tallentaa laskutukseen liittyviä liitteitä osaprojektille, osaprojektin ostolle tai myynnille. Liitetiedosto tuodaan Base 64 enkoodattuna rajapinnan kautta.
Liite-rajapinnan resurssien osoitteet
Osoite on muotoa:
https://rest.valueframe.com/rest/v2/{REST_resurssi}/
REST-resurssien osoitteet ovat seuraavat:
REST-resurssi | GET | PUT | POST | DELETE | KUVAUS |
Attachment | x | POST: lisää uuden liitteen |
Attachment-resurssi
Liitteeseen liittyvät tiedot:
Kentän nimi | Tyyppi | Kuvaus |
subprojectId * | INTEGER | Osaprojektin id |
saleId | INTEGER | Myynnin id. Myynnin id on annettava, jos liite halutaan kohdistaa osaprojektin tietylle myynnille |
purchaseId | INTEGER | Oston id. Oston id on annettava, jos liite halutaan kohdistaa osaprojektin tietylle ostolle |
name * | STRING | Liitteen nimi |
type | STRING | Liitteen tyypi. Toistaiseksi tuettuna vain "invoice". |
content * | STRING | Liite base 64 enkoodattuna |
description | STRING | Liitteen kuvaus |
Kutsu palauttaa liitteen id:n.
Käyttöesimerkkejä
Lisää liitteen osaprojektille (id=3)
{ "subprojectId": 3, "name": "Attachment 1", "type": "invoice", "content": "JVBERi0...MQ0KJSVFT0Y=\r\n", "description": "Attachment test" }
Lisää liitteen osaprojektin (id = 3) myynnille (id=75)
{ "subprojectId": 3, "name": "Attachment 1", "type": "invoice", "content": "JVBERi0...MQ0KJSVFT0Y=\r\n", "description": "Attachment test", "saleId": 75 }
Lisää liitteen osaprojektin (id=3) ostolle (id=18)
{ "subprojectId": 3, "name": "Attachment 1", "type": "invoice", "content": "JVBERi0...MQ0KJSVFT0Y=\r\n", "description": "Attachment test", "purchaseId": 18 }
Oliko tästä vastauksesta apua? Kyllä Ei
Send feedback