InvoicePaymentDto

Example Json Object

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "invoiceId": 0,
 5  "invoiceDisplayId": "string",
 6  "invoiceName": "string",
 7  "ledgerTransactionId": 0,
 8  "ledgerWorkspaceId": 0,
 9  "state": "INV_DRAFT",
10  "documentDate": "2019-08-24",
11  "postingDate": "2019-08-24",
12  "paymentLines": [
13    {
14      "id": 0,
15      "displayId": "string",
16      "invoicePaymentId": 0,
17      "invoicePaymentDisplayId": "string",
18      "invoiceLineItemId": 0,
19      "invoiceLineItemDisplayId": "string",
20      "invoiceLineItemDescription": "string",
21      "expenseCategoryDisplayId": "string",
22      "expenseCategoryName": "string",
23      "netAmount": 0,
24      "taxAmount": 0,
25      "allocatedNetAmountUsed": 0,
26      "allocatedTaxAmountUsed": 0,
27      "unfundedNetAmount": 0,
28      "unfundedTaxAmount": 0,
29      "totalAmount": 0,
30      "allowsSystemGenerateNewId": true,
31      "numberRangeIdentifierValue": "string",
32      "numberRangeIdentifierType": {
33        "name": "string"
34      },
35      "numberRangeType": {
36        "name": "string"
37      }
38    }
39  ],
40  "generatedInWorkspace": true,
41  "totalAllocatedNetAmount": 0,
42  "totalAmount": 0,
43  "totalNetAmount": 0,
44  "totalTaxAmount": 0,
45  "totalUnfundedNetAmount": 0,
46  "allowsSystemGenerateNewId": true,
47  "numberRangeIdentifierValue": "string",
48  "numberRangeIdentifierType": {
49    "name": "string"
50  },
51  "numberRangeType": {
52    "name": "string"
53  }
54}

📄 Description: Data transfer object representing the details of an invoice payment, including payment amount, method, and associated invoice information, facilitating streamlined financial transactions and reporting.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

invoiceId

integer(int64)

false

none

Unique identifier for the invoice

invoiceDisplayId

string

false

none

Unique identifier for the invoice display

invoiceName

string

false

none

Name of the invoice

ledgerTransactionId

integer(int64)

false

none

Unique identifier for the ledger transaction

ledgerWorkspaceId

integer(int64)

false

none

Unique identifier for the ledger workspace

state

string

false

none

Represents the current status of the invoice payment, indicating its progress within the payment lifecycle.

documentDate

string(date)

false

none

Date of the document

postingDate

string(date)

false

none

Date of the posting

paymentLines

[InvoicePaymentLineDto]

false

none

An array of payment line items associated with the invoice, detailing individual payment transactions for accurate financial tracking.

generatedInWorkspace

boolean

false

none

Indicates whether the invoice payment was generated within a specific workspace, ensuring accurate tracking of payment sources.

totalAllocatedNetAmount

number

false

none

Amount of total allocated net

totalAmount

number

false

none

Amount of total

totalNetAmount

number

false

none

Amount of total net

totalTaxAmount

number

false

none

Amount of total tax

totalUnfundedNetAmount

number

false

none

Amount of total unfunded net

allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

numberRangeIdentifierValue

string

false

none

Represents a unique string value that identifies the specific range of invoice payment transactions within the system.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeType

INumberRangeType

false

none

Type of the number range

Enumerated Values

Attribute

Value

state

GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW