Reshape revenue recognition schedule

curl --request POST \
  --url https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recognize_now_amount": "<string>",
  "window": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
  },
  "reason_detail": "<string>"
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape"

payload = {
    "recognize_now_amount": "<string>",
    "window": {
        "start_date": "2023-12-25",
        "end_date": "2023-12-25"
    },
    "reason_detail": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recognize_now_amount: '<string>',
    window: {start_date: '2023-12-25', end_date: '2023-12-25'},
    reason_detail: '<string>'
  })
};

fetch('https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recognize_now_amount' => '<string>',
    'window' => [
        'start_date' => '2023-12-25',
        'end_date' => '2023-12-25'
    ],
    'reason_detail' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape"

	payload := strings.NewReader("{\n  \"recognize_now_amount\": \"<string>\",\n  \"window\": {\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\"\n  },\n  \"reason_detail\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recognize_now_amount\": \"<string>\",\n  \"window\": {\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\"\n  },\n  \"reason_detail\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recognize_now_amount\": \"<string>\",\n  \"window\": {\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\"\n  },\n  \"reason_detail\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "method": "none",
  "discount_recognition_method": "immediate",
  "granularity": "day",
  "curve": "straight_line",
  "status": "pending",
  "origin": "auto",
  "is_arrears": true,
  "currency": "EUR",
  "total_amount": "<string>",
  "cancelled_amount": "<string>",
  "discount_amount": "<string>",
  "recognized_amount": "<string>",
  "recognized_discount_amount": "<string>",
  "remaining_amount": "<string>",
  "remaining_discount_amount": "<string>",
  "original_currency": "EUR",
  "original_currency_exchange_rate": "<string>",
  "original_currency_exchange_rate_date": "2023-12-25",
  "total_amount_in_original_currency": "<string>",
  "cancelled_amount_in_original_currency": "<string>",
  "discount_amount_in_original_currency": "<string>",
  "recognized_amount_in_original_currency": "<string>",
  "recognized_discount_amount_in_original_currency": "<string>",
  "remaining_amount_in_original_currency": "<string>",
  "remaining_discount_amount_in_original_currency": "<string>",
  "service_period_starts_at": "2023-12-25",
  "service_period_ends_at": "2023-12-25",
  "recognition_date": "2023-12-25",
  "total_units_snapshot": "<string>",
  "credit_transaction_id": "<string>",
  "deferred_ledger_account_id": "<string>",
  "revenue_ledger_account_id": "<string>",
  "deferred_discount_ledger_account_id": "<string>",
  "contra_revenue_ledger_account_id": "<string>",
  "unbilled_ledger_account_id": "<string>",
  "revenue_rule_id": "<string>",
  "deferred_rule_id": "<string>",
  "unbilled_rule_id": "<string>",
  "contra_revenue_rule_id": "<string>",
  "deferred_discount_rule_id": "<string>",
  "invoicing_entity_id": "<string>",
  "ledger_id": "<string>",
  "invoice_id": "<string>",
  "invoice_line_item_id": "<string>",
  "journal_entry_id": "<string>",
  "subscription_id": "<string>",
  "customer_id": "<string>",
  "billing_item_id": "<string>",
  "billing_item_on_subscription_id": "<string>",
  "amount_excluding_tax": "<string>",
  "tax_amount": "<string>",
  "amount_including_tax": "<string>",
  "invoice_line_item_name": "<string>",
  "earliest_spread_start": "2023-12-25",
  "timezone": "<string>",
  "slices": [
    {
      "id": "<string>",
      "schedule_id": "<string>",
      "kind": "planned",
      "status": "pending",
      "period_starts_at": "2023-12-25",
      "period_ends_at": "2023-12-25",
      "recognition_planned_at": "2023-12-25",
      "sequence": 123,
      "amount": "<string>",
      "discount_amount": "<string>",
      "original_currency": "EUR",
      "original_currency_exchange_rate": "<string>",
      "original_currency_exchange_rate_date": "2023-12-25",
      "amount_in_original_currency": "<string>",
      "discount_amount_in_original_currency": "<string>",
      "recognized_at": "2023-12-25",
      "journal_entry_id": "<string>",
      "reversing_journal_entry_id": "<string>",
      "usage_event_id": "<string>",
      "milestone_event_id": "<string>",
      "last_observed_units": "<string>",
      "ledger_id": "<string>",
      "invoicing_entity_id": "<string>",
      "amount_excluding_tax": "<string>",
      "tax_amount": "<string>",
      "amount_including_tax": "<string>"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

POST

accounting

revrec

schedules

{schedule_id}

reshape

Reshape revenue recognition schedule

curl --request POST \
  --url https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recognize_now_amount": "<string>",
  "window": {
    "start_date": "2023-12-25",
    "end_date": "2023-12-25"
  },
  "reason_detail": "<string>"
}
'

import requests

url = "https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape"

payload = {
    "recognize_now_amount": "<string>",
    "window": {
        "start_date": "2023-12-25",
        "end_date": "2023-12-25"
    },
    "reason_detail": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    recognize_now_amount: '<string>',
    window: {start_date: '2023-12-25', end_date: '2023-12-25'},
    reason_detail: '<string>'
  })
};

fetch('https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'recognize_now_amount' => '<string>',
    'window' => [
        'start_date' => '2023-12-25',
        'end_date' => '2023-12-25'
    ],
    'reason_detail' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape"

	payload := strings.NewReader("{\n  \"recognize_now_amount\": \"<string>\",\n  \"window\": {\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\"\n  },\n  \"reason_detail\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recognize_now_amount\": \"<string>\",\n  \"window\": {\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\"\n  },\n  \"reason_detail\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/accounting/revrec/schedules/{schedule_id}/reshape")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"recognize_now_amount\": \"<string>\",\n  \"window\": {\n    \"start_date\": \"2023-12-25\",\n    \"end_date\": \"2023-12-25\"\n  },\n  \"reason_detail\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "method": "none",
  "discount_recognition_method": "immediate",
  "granularity": "day",
  "curve": "straight_line",
  "status": "pending",
  "origin": "auto",
  "is_arrears": true,
  "currency": "EUR",
  "total_amount": "<string>",
  "cancelled_amount": "<string>",
  "discount_amount": "<string>",
  "recognized_amount": "<string>",
  "recognized_discount_amount": "<string>",
  "remaining_amount": "<string>",
  "remaining_discount_amount": "<string>",
  "original_currency": "EUR",
  "original_currency_exchange_rate": "<string>",
  "original_currency_exchange_rate_date": "2023-12-25",
  "total_amount_in_original_currency": "<string>",
  "cancelled_amount_in_original_currency": "<string>",
  "discount_amount_in_original_currency": "<string>",
  "recognized_amount_in_original_currency": "<string>",
  "recognized_discount_amount_in_original_currency": "<string>",
  "remaining_amount_in_original_currency": "<string>",
  "remaining_discount_amount_in_original_currency": "<string>",
  "service_period_starts_at": "2023-12-25",
  "service_period_ends_at": "2023-12-25",
  "recognition_date": "2023-12-25",
  "total_units_snapshot": "<string>",
  "credit_transaction_id": "<string>",
  "deferred_ledger_account_id": "<string>",
  "revenue_ledger_account_id": "<string>",
  "deferred_discount_ledger_account_id": "<string>",
  "contra_revenue_ledger_account_id": "<string>",
  "unbilled_ledger_account_id": "<string>",
  "revenue_rule_id": "<string>",
  "deferred_rule_id": "<string>",
  "unbilled_rule_id": "<string>",
  "contra_revenue_rule_id": "<string>",
  "deferred_discount_rule_id": "<string>",
  "invoicing_entity_id": "<string>",
  "ledger_id": "<string>",
  "invoice_id": "<string>",
  "invoice_line_item_id": "<string>",
  "journal_entry_id": "<string>",
  "subscription_id": "<string>",
  "customer_id": "<string>",
  "billing_item_id": "<string>",
  "billing_item_on_subscription_id": "<string>",
  "amount_excluding_tax": "<string>",
  "tax_amount": "<string>",
  "amount_including_tax": "<string>",
  "invoice_line_item_name": "<string>",
  "earliest_spread_start": "2023-12-25",
  "timezone": "<string>",
  "slices": [
    {
      "id": "<string>",
      "schedule_id": "<string>",
      "kind": "planned",
      "status": "pending",
      "period_starts_at": "2023-12-25",
      "period_ends_at": "2023-12-25",
      "recognition_planned_at": "2023-12-25",
      "sequence": 123,
      "amount": "<string>",
      "discount_amount": "<string>",
      "original_currency": "EUR",
      "original_currency_exchange_rate": "<string>",
      "original_currency_exchange_rate_date": "2023-12-25",
      "amount_in_original_currency": "<string>",
      "discount_amount_in_original_currency": "<string>",
      "recognized_at": "2023-12-25",
      "journal_entry_id": "<string>",
      "reversing_journal_entry_id": "<string>",
      "usage_event_id": "<string>",
      "milestone_event_id": "<string>",
      "last_observed_units": "<string>",
      "ledger_id": "<string>",
      "invoicing_entity_id": "<string>",
      "amount_excluding_tax": "<string>",
      "tax_amount": "<string>",
      "amount_including_tax": "<string>"
    }
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

schedule_id

string

required

Body

application/json

recognize_now_amount

string

required

Amount to recognize immediately in ledger currency.

Pattern: ^\d+(\.\d+)?$

reason_code

enum<string>

required

Stable reason code for the adjustment.

Available options:

obligation_satisfied_early,

renegotiated_delivery,

service_period_change,

setup_error,

other

window

object | null

Window over which to spread the remaining amount.

Show child attributes

reason_detail

string | null

Required explanation when reason_code is other.

Response

200 - application/json

string

required

Unique recognition-schedule identifier.

method

enum<string>

required

Revenue-recognition method.

Available options:

none,

point_in_time,

over_time,

usage_based,

milestone,

manual

discount_recognition_method

enum<string> | null

required

Method used to recognize discounts.

Available options:

immediate,

deferred,

use_net_amount

granularity

enum<string> | null

required

Recognition-slice granularity.

Available options:

day,

month,

quarter,

year

curve

enum<string> | null

required

Recognition allocation curve.

Available options:

straight_line,

custom

status

enum<string>

required

Recognition-schedule status.

Available options:

pending,

in_progress,

completed,

cancelled

origin

enum<string>

required

Origin of the recognition schedule.

Available options:

auto,

manual

is_arrears

boolean

required

Whether the schedule recognizes in-arrears revenue.

currency

enum<string>

required

ISO 4217 ledger currency.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

XOF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

total_amount

string

required

Total scheduled amount in ledger currency.

cancelled_amount

string

required

Cancelled amount in ledger currency.

discount_amount

string

required

Total discount amount in ledger currency.

recognized_amount

string

required

Recognized amount in ledger currency.

recognized_discount_amount

string

required

Recognized discount amount in ledger currency.

remaining_amount

string

required

Remaining amount in ledger currency.

remaining_discount_amount

string

required

Remaining discount amount in ledger currency.

original_currency

enum<string>

required

ISO 4217 original currency.

Available options:

EUR,

AED,

AFN,

XCD,

ALL,

AMD,

AOA,

ARS,

USD,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

XOF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

NOK,

BWP,

BYR,

BZD,

CAD,

CDF,

XAF,

CHF,

NZD,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

ANG,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

MAD,

ERN,

ETB,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

XPF,

NGN,

NIO,

NPR,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STD,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

UYU,

UZS,

VEF,

VND,

VUV,

WST,

YER,

ZAR,

ZMW,

ZWL

Example:

"EUR"

original_currency_exchange_rate

string

required

Exchange rate into ledger currency.

original_currency_exchange_rate_date

string<date> | null

required

Date of the exchange rate.

total_amount_in_original_currency

string

required

Total scheduled amount in the original currency.

cancelled_amount_in_original_currency

string

required

Cancelled amount in the original currency.

discount_amount_in_original_currency

string

required

Discount amount in the original currency.

recognized_amount_in_original_currency

string

required

Recognized amount in the original currency.

recognized_discount_amount_in_original_currency

string

required

Recognized discount amount in the original currency.

remaining_amount_in_original_currency

string

required

Remaining amount in the original currency.

remaining_discount_amount_in_original_currency

string

required

Remaining discount amount in the original currency.

service_period_starts_at

string<date> | null

required

Inclusive service-period start timestamp.

service_period_ends_at

string<date> | null

required

Inclusive service-period end timestamp.

recognition_date

string<date> | null

required

Recognition timestamp for point-in-time schedules.

total_units_snapshot

string | null

required

Usage-unit snapshot captured by the schedule.

credit_transaction_id

string | null

required

Related credit transaction identifier.

deferred_ledger_account_id

string | null

required

Deferred-revenue ledger account identifier.

revenue_ledger_account_id

string

required

Revenue ledger account identifier.

deferred_discount_ledger_account_id

string | null

required

Deferred-discount ledger account identifier.

contra_revenue_ledger_account_id

string | null

required

Contra-revenue ledger account identifier.

unbilled_ledger_account_id

string | null

required

Unbilled-revenue ledger account identifier.

revenue_rule_id

string | null

required

Revenue accounting-rule identifier.

deferred_rule_id

string | null

required

Deferred-revenue accounting-rule identifier.

unbilled_rule_id

string | null

required

Unbilled-revenue accounting-rule identifier.

contra_revenue_rule_id

string | null

required

Contra-revenue accounting-rule identifier.

deferred_discount_rule_id

string | null

required

Deferred-discount accounting-rule identifier.

invoicing_entity_id

string

required

Owning invoicing entity identifier.

ledger_id

string

required

Owning ledger identifier.

invoice_id

string | null

required

Related invoice identifier.

invoice_line_item_id

string | null

required

Related invoice line-item identifier.

journal_entry_id

string | null

required

Related manual journal-entry identifier.

subscription_id

string | null

required

Related subscription identifier.

customer_id

string | null

required

Related customer identifier.

billing_item_id

string | null

required

Related billing-item identifier.

billing_item_on_subscription_id

string | null

required

Related subscription billing-item identifier.

amount_excluding_tax

string

required

Schedule amount excluding tax.

tax_amount

string

required

Schedule tax amount.

amount_including_tax

string

required

Schedule amount including tax.

invoice_line_item_name

string | null

required

Display name of the related invoice line item or product.

earliest_spread_start

string<date>

required

Earliest permitted date for a forward reshape window.

timezone

string

required

IANA timezone used for schedule boundaries.

slices

object[]

required

Recognition slices in the schedule.

Show child attributes

created_at

string<date> | null

required

Timestamp when the schedule was created.

updated_at

string<date> | null

required

Timestamp when the schedule was last updated.

⌘I