Trendsic Platform Service

CloseoutItemPatchRequest

The following routes are available for this service:
PATCH,PUT,OPTIONS	/v1/projects/{ProjectID}/closeout/{CloseoutItemID}

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 CloseoutItem:
    closeout_item_i_d: int = 0
    closeout_item_u_i_d: Optional[str] = None
    project_i_d: int = 0
    item_key: Optional[str] = None
    label: Optional[str] = None
    detail: Optional[str] = None
    status: Optional[str] = None
    is_applicable: bool = False
    sort_order: int = 0
    completed_at: Optional[datetime.datetime] = None
    completed_by: Optional[str] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloseoutStatus:
    project_i_d: int = 0
    total_items: int = 0
    done_count: int = 0
    outstanding_count: int = 0
    all_clear: bool = False
    retainage_amount: Decimal = decimal.Decimal(0)
    retainage_released: bool = False
    released_pay_application_i_d: Optional[int] = None
    released_invoice_i_d: Optional[int] = None
    released_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloseoutListResponse:
    response_status: Optional[ResponseStatus] = None
    project_i_d: int = 0
    items: List[CloseoutItem] = field(default_factory=list)
    status: Optional[CloseoutStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CloseoutItemPatchRequest:
    project_i_d: int = 0
    closeout_item_i_d: int = 0
    status: Optional[str] = None
    detail: Optional[str] = None
    is_applicable: Optional[bool] = None

Python CloseoutItemPatchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/projects/{ProjectID}/closeout/{CloseoutItemID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	CloseoutItemID: 0,
	Status: String,
	Detail: String,
	IsApplicable: False
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	ProjectID: 0,
	Items: 
	[
		{
			CloseoutItemID: 0,
			CloseoutItemUID: 00000000000000000000000000000000,
			ProjectID: 0,
			ItemKey: String,
			Label: String,
			Detail: String,
			Status: String,
			IsApplicable: False,
			SortOrder: 0,
			CompletedAt: 0001-01-01,
			CompletedBy: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	Status: 
	{
		ProjectID: 0,
		TotalItems: 0,
		DoneCount: 0,
		OutstandingCount: 0,
		AllClear: False,
		RetainageAmount: 0,
		RetainageReleased: False,
		ReleasedPayApplicationID: 0,
		ReleasedInvoiceID: 0,
		ReleasedAt: 0001-01-01
	}
}