Billhighway Cloud API

UserObligation

The following routes are available for this service:
PUT	/invoices/recurringInvoices/obligation

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ErrorDetail:
    id: Optional[int] = None
    message: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObligationResponse(IHaveErrorField):
    error_details: Optional[List[ErrorDetail]] = None
    is_error: Optional[bool] = None
    member_count: Optional[int] = None
    total_amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ObligationLineItem:
    chart_of_account_id: Optional[int] = None
    chart_of_account_ref_id: Optional[str] = None
    amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserObligation:
    user_id: Optional[str] = None
    fiscal_year: Optional[int] = None
    group_id: Optional[str] = None
    line_items: Optional[List[ObligationLineItem]] = None
    opted_to_pay_c_t_a_dues: Optional[bool] = None

Python UserObligation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /invoices/recurringInvoices/obligation HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"UserId":"String","FiscalYear":0,"GroupId":"String","LineItems":[{"ChartOfAccountId":0,"ChartOfAccountRefId":"String","Amount":0}],"OptedToPayCTADues":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ErrorDetails":[{"Id":0,"Message":"String","Value":"String"}],"IsError":true,"MemberCount":0,"TotalAmount":0}