PayableGLScheduledPaymentDto¶
Example Json Object
1{
2 "ledgerTransactionId": 0,
3 "postingDate": "2019-08-24",
4 "ledgerEntryId": 0,
5 "entryType": "D",
6 "roundedAmount": 0,
7 "unroundedAmount": 0,
8 "deltaAdjustment": 0,
9 "tag": "string",
10 "company": {
11 "id": 0,
12 "displayId": "string"
13 },
14 "currency": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "decimalPoints": 0
20 },
21 "fiscalYear": 0,
22 "fiscalPeriod": 0,
23 "vendor": {
24 "id": 0,
25 "displayId": "string",
26 "status": "CREATED",
27 "name": "string",
28 "erpSystemDisplayId": "string"
29 },
30 "paymentMethod": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "type": "string"
36 },
37 "paymentBlock": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string"
42 },
43 "paymentTerm": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string"
48 },
49 "taxRoundedAmount": 0,
50 "taxUnroundedAmount": 0,
51 "taxDeltaAdjustment": 0,
52 "ledgerEntryTaxes": [
53 {
54 "ledgerEntryId": 0,
55 "ledgerEntryTaxId": 0,
56 "conditionKey": "string",
57 "accountingKey": "string",
58 "taxAccount": "string",
59 "taxRoundedAmount": 0,
60 "taxUnroundedAmount": 0,
61 "taxBaseAmount": 0,
62 "deltaAdjustment": 0,
63 "totalTaxDocumentAmount": 0,
64 "taxExempt": 0,
65 "taxAffected": 0,
66 "taxExemptionPercentage": 0,
67 "taxRate": 0.1,
68 "taxJurisdiction": {
69 "id": 0,
70 "displayId": "string"
71 },
72 "taxCode": {
73 "id": 0,
74 "displayId": "string"
75 },
76 "taxDetermination": {
77 "id": 0,
78 "displayId": "string"
79 },
80 "entryType": "D",
81 "ledgerEntryForAdditionalCurrencies": [
82 {
83 "id": 0,
84 "displayId": "string",
85 "entryType": "D",
86 "amount": 0,
87 "unroundedAmount": 0,
88 "deltaAdjustment": 0,
89 "currency": {
90 "id": 0,
91 "displayId": "string"
92 },
93 "currencyDefinitionType": "CONTRACT_CURRENCY",
94 "currencyType": "string",
95 "rate": 0,
96 "conversionDate": "2019-08-24",
97 "translationDateType": "DOCUMENT_DATE",
98 "sourceCurrencyType": "CONTRACT_CURRENCY",
99 "sourceCurrency": {
100 "id": 0,
101 "displayId": "string"
102 },
103 "depreciationArea": {
104 "id": 0,
105 "displayId": "string"
106 },
107 "ledgerEntryId": 0,
108 "ledgerEntryTaxId": 0,
109 "allowsSystemGenerateNewId": true,
110 "numberRangeIdentifierValue": "string",
111 "numberRangeIdentifierType": {
112 "name": "string"
113 },
114 "numberRangeType": {
115 "name": "string"
116 }
117 }
118 ]
119 }
120 ],
121 "contract": {
122 "id": 0,
123 "displayId": "string"
124 },
125 "activeContractRevisionId": 0,
126 "lease": {
127 "id": 0,
128 "displayId": "string"
129 },
130 "remainingAmount": 0,
131 "allocatedAmount": 0,
132 "matchedAmount": 0,
133 "postedAmount": 0,
134 "remainingTaxAmount": 0,
135 "state": "INV_DRAFT",
136 "approvalInfo": {
137 "approverUsername": "string",
138 "approvedAt": "2019-08-24T14:15:22Z"
139 },
140 "amountAllocations": [
141 {
142 "workspaceId": 0,
143 "workspaceDisplayId": "string",
144 "workspaceName": "string",
145 "vendorPaymentId": 0,
146 "amount": 0
147 }
148 ]
149}
📄 Description: Data transfer object representing a scheduled payment within the accounts payable system, encapsulating payment details and timing for effective financial management.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
ledgerTransactionId |
integer(int64) |
false |
none |
Unique identifier for the ledger transaction |
postingDate |
string(date) |
false |
none |
Date of the posting |
ledgerEntryId |
integer(int64) |
false |
none |
Unique identifier for the ledger entry |
entryType |
string |
false |
none |
Type of the entry |
roundedAmount |
number |
false |
none |
Amount of rounded |
unroundedAmount |
number |
false |
none |
Amount of unrounded |
deltaAdjustment |
number |
false |
none |
Represents the numerical adjustment value applied to the scheduled payment in the Payable GL, facilitating accurate financial reporting and reconciliation. |
tag |
string |
false |
none |
Represents a label or keyword associated with the scheduled payment, facilitating categorization and retrieval within the financial management system. |
company |
false |
none |
Represents the company associated with the scheduled payment, facilitating accurate financial tracking and reporting. |
|
currency |
false |
none |
Specifies the currency in which the scheduled payment is denominated, facilitating accurate financial transactions and reporting. |
|
fiscalYear |
integer(int32) |
false |
none |
Represents the fiscal year associated with the scheduled payment, facilitating accurate financial reporting and planning. |
fiscalPeriod |
integer(int32) |
false |
none |
Represents the fiscal period associated with the scheduled payment, facilitating accurate financial reporting and budgeting. |
vendor |
false |
none |
Identifies the vendor associated with the scheduled payment, facilitating accurate financial tracking and reporting. |
|
paymentMethod |
false |
none |
Specifies the method of payment to be used for processing the scheduled payment within the financial system. |
|
paymentBlock |
false |
none |
Indicates whether payments are temporarily restricted for a scheduled payment within the Payable GL framework. |
|
paymentTerm |
false |
none |
Specifies the agreed-upon duration for payment settlement related to scheduled transactions within the Payable GL framework. |
|
taxRoundedAmount |
number |
false |
none |
Amount of tax rounded |
taxUnroundedAmount |
number |
false |
none |
Amount of tax unrounded |
taxDeltaAdjustment |
number |
false |
none |
Represents the adjustment amount for tax-related discrepancies in scheduled payments, ensuring accurate financial reporting and compliance. |
ledgerEntryTaxes |
false |
none |
An array of tax entries associated with the scheduled payment, providing detailed financial breakdowns for accurate accounting and compliance. |
|
contract |
false |
none |
Represents the contractual agreement associated with the scheduled payment, facilitating accurate financial tracking and compliance. |
|
activeContractRevisionId |
integer(int64) |
false |
none |
Unique identifier for the active contract revision |
lease |
false |
none |
Represents the lease information associated with the scheduled payment, facilitating accurate financial tracking and reporting. |
|
remainingAmount |
number |
false |
none |
Amount of remaining |
allocatedAmount |
number |
false |
none |
Amount of allocated |
matchedAmount |
number |
false |
none |
Amount of matched |
postedAmount |
number |
false |
none |
Amount of posted |
remainingTaxAmount |
number |
false |
none |
Amount of remaining tax |
state |
string |
false |
none |
none |
approvalInfo |
false |
none |
Contains details regarding the approval status and related information for scheduled payments within the Payable GL framework. |
|
amountAllocations |
false |
none |
An array of scheduled payment allocations, detailing the distribution of amounts across various payable general ledger entries. |
Enumerated Values
Attribute |
Value |
|---|---|
entryType |
C, D |
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 |