Skip to main content
GET
/
customers
/
{customerId}
/
invoicing-schedule
Get invoicing schedule
curl --request GET \
  --url https://api.example.com/customers/{customerId}/invoicing-schedule
import requests

url = "https://api.example.com/customers/{customerId}/invoicing-schedule"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/customers/{customerId}/invoicing-schedule', 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.example.com/customers/{customerId}/invoicing-schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.example.com/customers/{customerId}/invoicing-schedule"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/customers/{customerId}/invoicing-schedule")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/customers/{customerId}/invoicing-schedule")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "issuedAt": "<string>",
      "period": {
        "startedAt": "<string>",
        "endedAt": "<string>"
      },
      "components": [
        {
          "id": "<string>",
          "premium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          },
          "reconciliation": true
        }
      ],
      "lines": [
        {
          "label": "<string>",
          "total": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          }
        }
      ],
      "total": {
        "amountPreFeesAndTaxes": 123,
        "fees": [
          {
            "id": "<string>",
            "amount": 123,
            "brokerageFirmId": "<string>"
          }
        ],
        "totalFees": 123,
        "amountWithFeesPreTaxes": 123,
        "taxes": [
          {
            "id": "<string>",
            "amount": 123
          }
        ],
        "totalTaxes": 123,
        "amountWithFeesAndTaxes": 123
      },
      "reconciledInvoiceIds": [
        "<array>"
      ]
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}

Path Parameters

​
customerId
string
required

Query Parameters

​
whenAt
string

Optional: the whenAt datetime

​
simulatedAt
string

Optional: the simulatedAt datetime

​
branchId
string

Optional: the branchId

​
excludeInvoiceIds
string[]

Invoice IDs to exclude from currentInvoiceIds when calculating the schedule

Response

​
data
object[]
required

Array invoice details

​
total
number

Optional: Total number of invoice details

​
offset
number

Optional: Number of invoice details the array has to star after

​
limit
number

Optional: Number of invoice details in the array