Billiecart API

<back to all web services

DeleteAdjustmentRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
DELETE/packages/{SalaryPackageId}/adjustments/{Id}
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


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IDelete):
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteOperationTenanted(Generic[TResponse], DeleteOperationUnTenanted[TResponse], ITenantedRequest):
    organisation_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteAdjustmentResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteAdjustmentRequest(DeleteOperationTenanted[DeleteAdjustmentResponse]):
    salary_package_id: Optional[str] = None
    id: Optional[str] = None

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

DELETE /packages/{SalaryPackageId}/adjustments/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}