Billhighway Cloud API

<back to all web services

CancelInvoice

The following routes are available for this service:
POST/invoices/misc/cancel
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 CancelInvoiceReply(IHaveErrorField):
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    invoice_number: Optional[str] = None
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CancelInvoice:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    opportunity_id: Optional[str] = None
    invoice_number: Optional[str] = None
    cancelled_by: Optional[str] = None
    cancel_reason: Optional[str] = None
    notes: Optional[str] = None

Python CancelInvoice 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.

POST /invoices/misc/cancel HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","OpportunityId":"String","InvoiceNumber":"String","CancelledBy":"String","CancelReason":"String","Notes":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"ErrorCode":0,"ErrorMessage":"String","InvoiceNumber":"String","IsError":false}