• TFAPI

Order

These requests are all about orders, viewing, creating and possibly in the future manipulating them to a certain extent.

post

Create order

Responses

Request examples

{
  "orderType": "NEW_SALE",
  "fromAddress": {
    "country": "NO",
    "postcode": "0579",
    "city": "OSLO",
    "streetName": "KARVESVINGEN",
    "houseNumber": 3,
    "houseLetter": "A",
    "dwellingNumber": "256",
    "floor": "2",
    "room": "14",
    "rack": null,
    "gabId": "285666461",
    "municipalityNumber": null,
    "cadastralUnitNumber": null,
    "propertyUnitNumber": null,
    "leaseholdNumber": null,
    "condominiumUnitNumber": null,
    "utmzone": null,
    "utme": null,
    "utmn": null,
    "latitude": null,
    "longitude": null
  },
  "fromLocalContact": {
    "name": null,
    "email": null,
    "telephone": null,
    "contactId": 2788470
  },
  "fromTechContact": {
    "name": "A tech contact name",
    "email": "atechemail@donotemail.com",
    "telephone": "+4712345678",
    "contactId": null
  },
  "toAddress": {
    "gabId": 223864814,
    "houseNumber": 1,
    "houseLetter": "B",
    "streetName": "JAABÆKVEGEN",
    "postcode": "2264",
    "city": "GRINDER",
    "country": "NORGE",
    "room": "16",
    "floor": "2",
    "dwellingNumber": "12",
    "rack": null,
    "municipalityNumber": null,
    "cadastralUnitNumber": null,
    "propertyUnitNumber": null,
    "leaseholdNumber": null,
    "condominiumUnitNumber": null,
    "utmzone": null,
    "utme": null,
    "utmn": null,
    "latitude": null,
    "longitude": null
  },
  "toLocalContact": null,
  "toTechContact": {
    "name": "A tech contact name",
    "email": "atechemail@donotemail.com",
    "telephone": "+4712345678",
    "contactId": null
  },
  "equipmentDeliveryAddress": {
    "name": "Reciever",
    "coName": null,
    "address": "0301-107/583 583 0000",
    "postCode": "1088",
    "city": "OSLO",
    "country": "Norway"
  },
  "requestedStartDate": "2022-09-22T07:14:36Z",
  "contractLength": 24,
  "seller": {
    "id": 2884815
  },
  "orderer": {
    "id": 2788470
  },
  "contact": {
    "id": 2788470
  },
  "requestedDate": "2023-07-20T07:14:36Z",
  "customer": {
    "id": 136748,
    "invoiceGroupId": 70162
  },
  "createdBy": {
    "id": 2884815
  },
  "originSystem": "YOURSYSTEM",
  "customersOwnReference": "what",
  "installerComment": "comment to Installer",
  "comment": "My order comment",
  "reference": "A new btag",
  "requestedConnectionId": null,
  "campaignCodeApplied": false,
  "campaignCode": null,
  "compoundOrderNumber": null,
  "status": "Offer",
  "new_lines": [
    {
      "articleId": "1234",
      "recurringPrice": 1234,
      "currency": "NOK",
      "numberOfItems": 1,
      "configuration": [
        {
          "key": 3000075,
          "value": "100 Mbit/s"
        }
      ]
    },
    {
      "articleId": "12345",
      "recurringPrice": 234,
      "currency": "NOK",
      "numberOfItems": 1,
      "additionalInfoOnInvoice": "some text for the customers invoice"
    },
    {
      "articleId": "54321",
      "oneTimePrice": 15000,
      "currency": "NOK",
      "numberOfItems": 1,
      "additionalInfoOnInvoice": "A different text for a different line max 60 characters"
    }
  ],
  "annotations": [
    {
      "text": "any text here, can be up to 4000 characters",
      "createdByUser": 2960255
    },
    {
      "text": "Another annotation here, which can be up to 4000 characters",
      "createdByUser": 2960255
    }
  ]
}

Response examples

Created

{}
get

The data of all available orders

qstring
Example
"{\"text\":{\"$instr\":\"NPT\"}}"

Responses

Response examples

Successful response

Empty response

get

The data of a single order

order_idint

required

Example
"1234"

Responses

Response examples

Successful response

Empty response

put

Update order

Allows you to update certain fields on an order. Currently we only support updating the and the requestedStartDate and requestedConnectionId

Responses

Request examples

{
  "orderType": "NEW_SALE",
  "fromAddress": {
    "country": "NO",
    "postcode": "0579",
    "city": "OSLO",
    "streetName": "KARVESVINGEN",
    "houseNumber": 3,
    "houseLetter": "A",
    "dwellingNumber": "256",
    "floor": "2",
    "room": "14",
    "rack": null,
    "gabId": "285666461",
    "municipalityNumber": null,
    "cadastralUnitNumber": null,
    "propertyUnitNumber": null,
    "leaseholdNumber": null,
    "condominiumUnitNumber": null,
    "utmzone": null,
    "utme": null,
    "utmn": null,
    "latitude": null,
    "longitude": null
  },
  "fromLocalContact": {
    "name": null,
    "email": null,
    "telephone": null,
    "contactId": 2788470
  },
  "fromTechContact": null,
  "toAddress": {
    "gabId": 223864814,
    "houseNumber": 1,
    "houseLetter": "B",
    "streetName": "JAABÆKVEGEN",
    "postcode": "2264",
    "city": "GRINDER",
    "country": "NORGE",
    "room": "16",
    "floor": "2",
    "dwellingNumber": "12",
    "rack": null,
    "municipalityNumber": null,
    "cadastralUnitNumber": null,
    "propertyUnitNumber": null,
    "leaseholdNumber": null,
    "condominiumUnitNumber": null,
    "utmzone": null,
    "utme": null,
    "utmn": null,
    "latitude": null,
    "longitude": null
  },
  "toLocalContact": null,
  "toTechContact": {
    "name": "A tech contact name",
    "email": "atechemail@donotemail.com",
    "telephone": "+4712345678",
    "contactId": null
  },
  "equipmentDeliveryAddress": {
    "name": "Reciever",
    "coName": null,
    "address": "0301-107/583 583 0000",
    "postCode": "1088",
    "city": "OSLO",
    "country": "Norway"
  },
  "requestedStartDate": "2022-09-22T07:14:36Z",
  "contractLength": 24,
  "seller": {
    "id": 2884815
  },
  "orderer": {
    "id": 2788470
  },
  "contact": {
    "id": 2788470
  },
  "requestedDate": "2023-07-25T07:14:36Z",
  "customer": {
    "id": 136748,
    "invoiceGroupId": "70162"
  },
  "createdBy": {
    "id": 2884815
  },
  "originSystem": "YOURSYSTEM",
  "customersOwnReference": "what",
  "installerComment": "comment to Installer",
  "comment": "An updated comment",
  "reference": "A new btag",
  "requestedConnectionId": null,
  "campaignCodeApplied": false,
  "campaignCode": null,
  "compoundOrderNumber": null,
  "status": "Offer",
  "new_lines": [
    {
      "articleId": "1234",
      "recurringPrice": 1234,
      "currency": "NOK",
      "numberOfItems": 1,
      "configuration": [
        {
          "key": 3000075,
          "value": "100 Mbit/s"
        }
      ]
    },
    {
      "articleId": "4321",
      "recurringPrice": 234,
      "currency": "NOK",
      "numberOfItems": 1,
      "additionalInfoOnInvoice": "some text for the customers invoice"
    },
    {
      "articleId": "1234-E",
      "oneTimePrice": 15000,
      "currency": "NOK",
      "numberOfItems": 1,
      "additionalInfoOnInvoice": "A different text for a different line max 60 characters"
    }
  ],
  "annotations": [
    {
      "text": "any text here, can be up to 4000 characters",
      "createdByUser": 2960255
    },
    {
      "text": "Another annotation here, which can be up to 4000 characters",
      "createdByUser": 2960255
    }
  ]
}

Response examples

Successful response

Empty response

post

Termination order creation

Responses

Request examples

{
  "connection_id": "12345678",
  "requested_termination_date": "2023-04-21T13:55:55.2804054Z",
  "system_id": 26,
  "comment": "Test creation of termination order"
}

Response examples

Successful response

Empty response

Was this page helpful?