PUT | /invoices/recurringInvoices/obligations |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | string | No | |
FiscalYear | form | int | No | |
GroupId | form | string | No | |
LineItems | form | List<ObligationLineItem> | No | |
OptedToPayCTADues | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ChartOfAccountId | form | int | No | |
ChartOfAccountRefId | form | string | No | |
Amount | form | decimal? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorDetails | form | List<ErrorDetail> | No | |
IsError | form | bool | No | |
MemberCount | form | int | No | |
TotalAmount | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Message | form | string | No | |
Value | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /invoices/recurringInvoices/obligations HTTP/1.1
Host: devapi.billhighway.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
[]
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}