Billing period

Element type: Required

Enpoints/models used: BillingPeriod

Your integration must provide a way for users to specify the billing period (month and year) for an invoice. This is done using the bpd model within the Invoice model. In this configuration, months are specified using a numeric value from 1 to 12, with 1 representing January and so on.

View example:

 "inv": [
  {
    "doc": "StreamingContent1",
    "cmmt": false,
    "cust": 0,
    "date": "2021-01-01T12:00:00Z",
    "invm": true,
    "dtl": true,
    "summ": true,
    "acct": "Broadcaster",
    "custref": "Customer1234",
    "invn": "Invoice1234",
    "bcyc": "202010",
    "bpd": {
        "month": "10",
        "year": "2020"
    },
    "opt": [
        {
            "key": "1",
            "val": "StreamingSamples"
        }
    ],
    "bill": {
      ...
    },
    "itms": [
      {
        ...
      }
    ]
  }
]