| GET | /invoices/recurringInvoices/obligation |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.RecurringInvoice.Request;
using BH.CloudAPI.Common4.DTO.RecurringInvoice.Response;
namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Request
{
public partial class ObligationLineItem
{
public virtual int ChartOfAccountId { get; set; }
public virtual string ChartOfAccountRefId { get; set; }
public virtual decimal? Amount { get; set; }
}
public partial class UserObligationsRequest
{
public virtual string GroupId { get; set; }
public virtual string UserId { get; set; }
public virtual int FiscalYear { get; set; }
public virtual bool ShowHistory { get; set; }
}
}
namespace BH.CloudAPI.Common4.DTO.RecurringInvoice.Response
{
public partial class Obligation
{
public Obligation()
{
LineItems = new List<ObligationLineItem>{};
}
public virtual DateTime CreatedDate { get; set; }
public virtual DateTime LastUpdateDate { get; set; }
public virtual bool IsActive { get; set; }
public virtual List<ObligationLineItem> LineItems { get; set; }
}
public partial class ObligationUser
{
public ObligationUser()
{
FiscalYears = new List<ObligationYear>{};
}
public virtual string UserId { get; set; }
public virtual string GroupId { get; set; }
public virtual List<ObligationYear> FiscalYears { get; set; }
}
public partial class ObligationYear
{
public ObligationYear()
{
Obligations = new List<Obligation>{};
}
public virtual int FiscalYear { get; set; }
public virtual List<Obligation> Obligations { get; set; }
}
}
C# UserObligationsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /invoices/recurringInvoices/obligation HTTP/1.1 Host: devapi.billhighway.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UserId: String,
GroupId: String,
FiscalYears:
[
{
FiscalYear: 0,
Obligations:
[
{
CreatedDate: 0001-01-01,
LastUpdateDate: 0001-01-01,
IsActive: False,
LineItems:
[
{
ChartOfAccountRefId: String,
Amount: 0
}
]
}
]
}
]
}