GET sopimukset/{sopimus_id}/maksulajit/hae

Hakee sopimuksen maksulajit ja tariffit


Request Information

URI Parameters

NameDescriptionTypeAdditional information
sopimus_id integer Required

Body Parameters

None.


Response Information

Resource Description


Collection of ApiSopimusMaksulajiResponse
NameDescriptionTypeAdditional information
MaksulajiId Maksulajin yksilöllinen id. integer None.
MaksulajiNimi Maksulajin nimi. string None.
Veloitusperuste Veloitusperusteen selite. string None.
VeloitusperusteId Veloitusperusteen id. integer None.
Pakollinen Onko maksulaji ns. pakollinen sopimukselle, kun kohteelle tehdään sopimus. boolean None.
Kuitille Tuleeko maksulajin hinta sopimuksen kuitille asti. boolean None.
AlisopimuksenKohdetyyppiId Kohdetyypin id, jonka mukaiselle kohteelle pitää tehdä alisopimus sopimukselle, jolle tätä maksulajia ollaan lisäämässä. integer None.
Tyyppi Maksulajin tyyppi. ApiMaksulajiTyyppi None.
Kuvaus Maksulajin kuvaus string None.
Saatavalaji Maksulajin saatavalaji string None.
Alkupvm Maksulajin alkupäivä date None.
Loppupvm Maksulajin päättymispäivä date None.
VeloitusperusteKerroin Yksikköhinnan kerroin decimal number None.
Hinnat Maksulajin hinnat Collection of ApiSopimusMaksulajiTariffiResponse None.

Response Formats

application/json, text/json
Sample:
[
  {
    "MaksulajiId": 1,
    "MaksulajiNimi": "sample string 2",
    "Veloitusperuste": "sample string 3",
    "VeloitusperusteId": 1,
    "Pakollinen": true,
    "Kuitille": true,
    "AlisopimuksenKohdetyyppiId": 1,
    "Tyyppi": 1,
    "Kuvaus": "sample string 6",
    "Saatavalaji": "sample string 7",
    "Alkupvm": "2024-04-20T15:33:02.1844972+03:00",
    "Loppupvm": "2024-04-20T15:33:02.1844972+03:00",
    "VeloitusperusteKerroin": 9.0,
    "Hinnat": [
      {
        "Alkupvm": "2024-04-20T15:33:02.1844972+03:00",
        "Yksikkohinta": 1.0,
        "Hinta": 1.0,
        "VeloitusperusteKerroin": 2.0
      },
      {
        "Alkupvm": "2024-04-20T15:33:02.1844972+03:00",
        "Yksikkohinta": 1.0,
        "Hinta": 1.0,
        "VeloitusperusteKerroin": 2.0
      }
    ]
  },
  {
    "MaksulajiId": 1,
    "MaksulajiNimi": "sample string 2",
    "Veloitusperuste": "sample string 3",
    "VeloitusperusteId": 1,
    "Pakollinen": true,
    "Kuitille": true,
    "AlisopimuksenKohdetyyppiId": 1,
    "Tyyppi": 1,
    "Kuvaus": "sample string 6",
    "Saatavalaji": "sample string 7",
    "Alkupvm": "2024-04-20T15:33:02.1844972+03:00",
    "Loppupvm": "2024-04-20T15:33:02.1844972+03:00",
    "VeloitusperusteKerroin": 9.0,
    "Hinnat": [
      {
        "Alkupvm": "2024-04-20T15:33:02.1844972+03:00",
        "Yksikkohinta": 1.0,
        "Hinta": 1.0,
        "VeloitusperusteKerroin": 2.0
      },
      {
        "Alkupvm": "2024-04-20T15:33:02.1844972+03:00",
        "Yksikkohinta": 1.0,
        "Hinta": 1.0,
        "VeloitusperusteKerroin": 2.0
      }
    ]
  }
]
application/xml, text/xml
Sample:
<ArrayOfApiSopimusMaksulajiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Agenteq.Tampuuri.ApplicationServiceApi.Contract.Asiakaspalvelu.Maksuvalvonta">
  <ApiSopimusMaksulajiResponse>
    <AlisopimuksenKohdetyyppiId>1</AlisopimuksenKohdetyyppiId>
    <Alkupvm>2024-04-20T15:33:02.1844972+03:00</Alkupvm>
    <Hinnat>
      <ApiSopimusMaksulajiTariffiResponse>
        <Alkupvm>2024-04-20T15:33:02.1844972+03:00</Alkupvm>
        <Hinta>1</Hinta>
        <VeloitusperusteKerroin>2</VeloitusperusteKerroin>
        <Yksikkohinta>1</Yksikkohinta>
      </ApiSopimusMaksulajiTariffiResponse>
      <ApiSopimusMaksulajiTariffiResponse>
        <Alkupvm>2024-04-20T15:33:02.1844972+03:00</Alkupvm>
        <Hinta>1</Hinta>
        <VeloitusperusteKerroin>2</VeloitusperusteKerroin>
        <Yksikkohinta>1</Yksikkohinta>
      </ApiSopimusMaksulajiTariffiResponse>
    </Hinnat>
    <Kuitille>true</Kuitille>
    <Kuvaus>sample string 6</Kuvaus>
    <Loppupvm>2024-04-20T15:33:02.1844972+03:00</Loppupvm>
    <MaksulajiId>1</MaksulajiId>
    <MaksulajiNimi>sample string 2</MaksulajiNimi>
    <Pakollinen>true</Pakollinen>
    <Saatavalaji>sample string 7</Saatavalaji>
    <Tyyppi>Maksulaji</Tyyppi>
    <Veloitusperuste>sample string 3</Veloitusperuste>
    <VeloitusperusteId>1</VeloitusperusteId>
    <VeloitusperusteKerroin>9</VeloitusperusteKerroin>
  </ApiSopimusMaksulajiResponse>
  <ApiSopimusMaksulajiResponse>
    <AlisopimuksenKohdetyyppiId>1</AlisopimuksenKohdetyyppiId>
    <Alkupvm>2024-04-20T15:33:02.1844972+03:00</Alkupvm>
    <Hinnat>
      <ApiSopimusMaksulajiTariffiResponse>
        <Alkupvm>2024-04-20T15:33:02.1844972+03:00</Alkupvm>
        <Hinta>1</Hinta>
        <VeloitusperusteKerroin>2</VeloitusperusteKerroin>
        <Yksikkohinta>1</Yksikkohinta>
      </ApiSopimusMaksulajiTariffiResponse>
      <ApiSopimusMaksulajiTariffiResponse>
        <Alkupvm>2024-04-20T15:33:02.1844972+03:00</Alkupvm>
        <Hinta>1</Hinta>
        <VeloitusperusteKerroin>2</VeloitusperusteKerroin>
        <Yksikkohinta>1</Yksikkohinta>
      </ApiSopimusMaksulajiTariffiResponse>
    </Hinnat>
    <Kuitille>true</Kuitille>
    <Kuvaus>sample string 6</Kuvaus>
    <Loppupvm>2024-04-20T15:33:02.1844972+03:00</Loppupvm>
    <MaksulajiId>1</MaksulajiId>
    <MaksulajiNimi>sample string 2</MaksulajiNimi>
    <Pakollinen>true</Pakollinen>
    <Saatavalaji>sample string 7</Saatavalaji>
    <Tyyppi>Maksulaji</Tyyppi>
    <Veloitusperuste>sample string 3</Veloitusperuste>
    <VeloitusperusteId>1</VeloitusperusteId>
    <VeloitusperusteKerroin>9</VeloitusperusteKerroin>
  </ApiSopimusMaksulajiResponse>
</ArrayOfApiSopimusMaksulajiResponse>