Billiecart API

UpdatePaymentRequest

**Requires Authentication**
Requires the role:	manager

The following routes are available for this service:
PUT	/payments/{Id}


export class PutOperationUnTenanted<TResponse> implements IPut
{

    public constructor(init?: Partial<PutOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class PutOperationTenanted<TResponse> extends PutOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<PutOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class BankAccount
{
    public bsbNumber?: string;
    public accountNumber?: string;

    public constructor(init?: Partial<BankAccount>) { (Object as any).assign(this, init); }
}

export class Payment implements IIdentifiableResource
{
    public salaryPackageId?: string;
    public amount: number;
    public gstAmount: number;
    public particulars?: string;
    public budgetCategory?: string;
    public status?: string;
    public toAccount?: BankAccount;
    public id?: string;

    public constructor(init?: Partial<Payment>) { (Object as any).assign(this, init); }
}

export class UpdatePaymentResponse
{
    public responseStatus?: ResponseStatus;
    public payment?: Payment;

    public constructor(init?: Partial<UpdatePaymentResponse>) { (Object as any).assign(this, init); }
}

export class UpdatePaymentRequest extends PutOperationTenanted<UpdatePaymentResponse>
{
    public id?: string;
    public amount: number;
    public gstAmount: number;
    public particulars?: string;
    public budgetCategory?: string;

    public constructor(init?: Partial<UpdatePaymentRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UpdatePaymentRequest 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.

PUT /payments/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"String","amount":0,"gstAmount":0,"particulars":"String","budgetCategory":"String","organisationId":"String"}

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"}},"payment":{"salaryPackageId":"String","amount":0,"gstAmount":0,"particulars":"String","budgetCategory":"String","status":"String","toAccount":{"bsbNumber":"String","accountNumber":"String"},"id":"String"}}