regis

<back to all web services

InvoiceDynamicsAuditLogsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/finance/invoice-dynamics-audit/logs
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 InvoiceDynamicsTransactionResponse:
    dynamics_log_id: Optional[int] = None
    action: Optional[str] = None
    note: Optional[str] = None
    logged_amount: Optional[Decimal] = None
    document_number: Optional[str] = None
    customer_number: Optional[str] = None
    logged_at: Optional[datetime.datetime] = None
    regis_invoice_reference: Optional[str] = None
    gp_source: Optional[str] = None
    found_in_gp: bool = False
    gp_type: int = 0
    gp_status: int = 0
    batch_number: Optional[str] = None
    gp_amount: Optional[Decimal] = None
    is_open: bool = False
    is_posted: bool = False
    is_void: bool = False
    document_date: Optional[datetime.datetime] = None
    posting_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceEconnectLogResponse:
    id: int = 0
    timestamp: datetime.datetime = datetime.datetime(1, 1, 1)
    xml: Optional[str] = None
    response: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceDynamicsAuditResponse:
    invoice_id: Optional[int] = None
    invoice_uuid: Optional[str] = None
    reporting_term: Optional[str] = None
    invoice_date: Optional[datetime.datetime] = None
    invoice_status: Optional[str] = None
    description: Optional[str] = None
    total_charges: Decimal = decimal.Decimal(0)
    total_credits: Decimal = decimal.Decimal(0)
    net: Decimal = decimal.Decimal(0)
    regent_id: int = 0
    student_uuid: Optional[str] = None
    student_name: Optional[str] = None
    initiator_name: Optional[str] = None
    has_regis_invoice: bool = False
    reconciliation_type: Optional[str] = None
    dynamics_status: Optional[str] = None
    dynamics_transactions: Optional[List[InvoiceDynamicsTransactionResponse]] = None
    econnect_logs: Optional[List[InvoiceEconnectLogResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceDynamicsAuditLogsRequest:
    invoice_id: Optional[int] = None
    document_number: Optional[str] = None
    authorizing_uuid: Optional[str] = None

Python InvoiceDynamicsAuditLogsRequest 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 /finance/invoice-dynamics-audit/logs HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InvoiceDynamicsAuditLogsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <document_number>String</document_number>
  <invoice_id>0</invoice_id>
</InvoiceDynamicsAuditLogsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvoiceDynamicsAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <description>String</description>
  <dynamics_status>String</dynamics_status>
  <dynamics_transactions>
    <InvoiceDynamicsTransactionResponse>
      <action>String</action>
      <batch_number>String</batch_number>
      <customer_number>String</customer_number>
      <document_date>0001-01-01T00:00:00</document_date>
      <document_number>String</document_number>
      <dynamics_log_id>0</dynamics_log_id>
      <found_in_gp>false</found_in_gp>
      <gp_amount>0</gp_amount>
      <gp_source>String</gp_source>
      <gp_status>0</gp_status>
      <gp_type>0</gp_type>
      <is_open>false</is_open>
      <is_posted>false</is_posted>
      <is_void>false</is_void>
      <logged_amount>0</logged_amount>
      <logged_at>0001-01-01T00:00:00</logged_at>
      <note>String</note>
      <posting_date>0001-01-01T00:00:00</posting_date>
      <regis_invoice_reference>String</regis_invoice_reference>
    </InvoiceDynamicsTransactionResponse>
  </dynamics_transactions>
  <econnect_logs>
    <InvoiceEconnectLogResponse>
      <id>0</id>
      <response>String</response>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <xml>String</xml>
    </InvoiceEconnectLogResponse>
  </econnect_logs>
  <has_regis_invoice>false</has_regis_invoice>
  <initiator_name>String</initiator_name>
  <invoice_date>0001-01-01T00:00:00</invoice_date>
  <invoice_id>0</invoice_id>
  <invoice_status>String</invoice_status>
  <invoice_uuid>String</invoice_uuid>
  <reconciliation_type>String</reconciliation_type>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <student_name>String</student_name>
  <student_uuid>String</student_uuid>
  <total_charges>0</total_charges>
  <total_credits>0</total_credits>
</InvoiceDynamicsAuditResponse>