Trendsic Platform Service

<back to all web services

InvoiceWorkChangesDecideRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/invoice/workchanges/{ProjectUID}/decide
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 InvoiceWorkChange:
    source_type: Optional[str] = None
    source_i_d: int = 0
    job_i_d: Optional[int] = None
    work_date: Optional[datetime.datetime] = None
    work_day: Optional[str] = None
    display_day: Optional[str] = None
    label: Optional[str] = None
    job_name: Optional[str] = None
    display_date: Optional[datetime.datetime] = None
    unit: Optional[str] = None
    billed: Decimal = decimal.Decimal(0)
    now_quantity: Decimal = decimal.Decimal(0)
    over_billed: Decimal = decimal.Decimal(0)
    unit_factor: Decimal = decimal.Decimal(0)
    price: Decimal = decimal.Decimal(0)
    amount: Decimal = decimal.Decimal(0)
    line_type: Optional[str] = None
    is_taxable: bool = False
    invoice_i_d: int = 0
    invoice_u_i_d: Optional[str] = None
    invoice_number: Optional[str] = None
    invoice_total: Decimal = decimal.Decimal(0)
    invoice_is_locked: bool = False
    invoice_is_paid: bool = False
    state: Optional[str] = None
    remembered: Optional[str] = None
    decided_by_name: Optional[str] = None
    decided_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceWorkChangesResponse:
    response_status: Optional[ResponseStatus] = None
    success: bool = False
    changes: List[InvoiceWorkChange] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceWorkChangeKey:
    source_type: Optional[str] = None
    source_i_d: int = 0
    job_i_d: Optional[int] = None
    work_day: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceWorkChangesDecideRequest:
    project_u_i_d: Optional[str] = None
    invoice_i_d: int = 0
    decision: Optional[str] = None
    remember: bool = False
    sources: List[InvoiceWorkChangeKey] = field(default_factory=list)

Python InvoiceWorkChangesDecideRequest DTOs

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

HTTP + XML

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

POST /v1/invoice/workchanges/{ProjectUID}/decide HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InvoiceWorkChangesDecideRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Decision>String</Decision>
  <InvoiceID>0</InvoiceID>
  <ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
  <Remember>false</Remember>
  <Sources>
    <InvoiceWorkChangeKey>
      <JobID>0</JobID>
      <SourceID>0</SourceID>
      <SourceType>String</SourceType>
      <WorkDay>String</WorkDay>
    </InvoiceWorkChangeKey>
  </Sources>
</InvoiceWorkChangesDecideRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvoiceWorkChangesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Changes>
    <InvoiceWorkChange>
      <Amount>0</Amount>
      <Billed>0</Billed>
      <DecidedAt>0001-01-01T00:00:00</DecidedAt>
      <DecidedByName>String</DecidedByName>
      <DisplayDate>0001-01-01T00:00:00</DisplayDate>
      <DisplayDay>String</DisplayDay>
      <InvoiceID>0</InvoiceID>
      <InvoiceIsLocked>false</InvoiceIsLocked>
      <InvoiceIsPaid>false</InvoiceIsPaid>
      <InvoiceNumber>String</InvoiceNumber>
      <InvoiceTotal>0</InvoiceTotal>
      <InvoiceUID>00000000-0000-0000-0000-000000000000</InvoiceUID>
      <IsTaxable>false</IsTaxable>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <Label>String</Label>
      <LineType>String</LineType>
      <NowQuantity>0</NowQuantity>
      <OverBilled>0</OverBilled>
      <Price>0</Price>
      <Remembered>String</Remembered>
      <SourceID>0</SourceID>
      <SourceType>String</SourceType>
      <State>String</State>
      <Unit>String</Unit>
      <UnitFactor>0</UnitFactor>
      <WorkDate>0001-01-01T00:00:00</WorkDate>
      <WorkDay>String</WorkDay>
    </InvoiceWorkChange>
  </Changes>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Success>false</Success>
</InvoiceWorkChangesResponse>