Keikkalaskun kumppanirajapinta

Kumppanirajapinnan avulla keikka-alusta luo työntekijöilleen laskutuspyyntöjä Keikkalaskun kautta. Keikkalasku laskuttaa teitä (kumppania), pidättää normaalin palvelumaksunsa ja maksaa jokaiselle työntekijälle palkan — verot, vakuutukset ja ilmoitukset hoidettuina.

Näin se toimii

  1. Kutsu kukin työntekijä kerran — POST /v1/connections omalla tunnisteellanne ja työntekijän sähköpostilla. Keikkalasku lähettää kutsun; työntekijä hyväksyy sen Keikkalaskussa samalla sähköpostilla olevalla tilillä. Kutsu on voimassa 30 päivää.
  2. Ilmoita keikat — POST /v1/gigs: keikan päivä, otsikko, työtyyppi ja kunkin työntekijän osuus ilman arvonlisäveroa. Jokaisesta työntekijästä syntyy yksi laskutuspyyntö, jonka vastaanottaja olette te.
  3. Seuraa tilaa — GET /v1/gigs?updated_since=…. Työntekijän tila etenee awaiting_worker → received → invoiced → paid → completed. Tilassa invoiced vastaus sisältää laskun numeron, viitteen, eräpäivän, summan ja IBANin, joten maksamisen voi automatisoida.

Vastaanottajaa tai ALV-kantaa ei koskaan lähetetä. Vastaanottaja on Keikkalaskun teille tallentamat laskutustiedot, ja ALV määräytyy työtyypin koodista ja keikan päivästä.

Ympäristöt

Osoite Avaimet
Testi https://api-test-pp.keikkis.fi/v1 kl_test_…
Tuotanto https://api-pp.keikkis.fi/v1 kl_live_…

Testirajapinta tarkistaa jokaisen pyynnön täsmälleen kuten tuotanto, mutta vastaa kiinteällä testidatalla eikä tallenna mitään. Taikaarvoilla saa esiin jokaisen tilan ja virheen: katso Testirajapinta. Testiavain toimii vain testiosoitteessa ja tuotantoavain vain tuotanto-osoitteessa (401 wrong_environment).

Avaimet luodaan kumppaniportaalissa. Testiavaimen saa heti, tuotantoavaimen kun Keikkalasku on avannut tuotantokäytön (kumppanisopimuksen, tietojenkäsittelysopimuksen ja asiakkaan tuntemisen jälkeen).

Sivut

Jokainen sivu on saatavilla myös Markdownina: lisää osoitteen perään .md, esim. /docs/fi/quickstart.md.