| POST | /invoices/misc/cancelcollection |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CancelInvoices | body | List<CancelInvoice> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassName | form | string | No | |
| UniqueId | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| ClientId | form | int | No | |
| GroupId | form | string | No | |
| OpportunityId | form | string | No | |
| InvoiceNumber | form | string | No | |
| CancelledBy | form | string | No | |
| CancelReason | form | string | No | |
| Notes | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CancelInvoiceReply | form | List<CancelInvoiceReply> | No | |
| IsError | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassName | form | string | No | |
| UniqueId | form | string | No | |
| CreatedDateTime | form | DateTime | No | |
| ClientId | form | int | No | |
| ErrorCode | form | int | No | |
| ErrorMessage | form | string | No | |
| InvoiceNumber | form | string | No | |
| IsError | form | bool | No |
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.
POST /invoices/misc/cancelcollection HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CancelInvoices:
[
{
ClassName: String,
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
GroupId: String,
OpportunityId: String,
InvoiceNumber: String,
CancelledBy: String,
CancelReason: String,
Notes: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
CancelInvoiceReply:
[
{
ClassName: String,
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
ErrorCode: 0,
ErrorMessage: String,
InvoiceNumber: String,
IsError: False
}
],
IsError: False
}