Update Installments on an Invoice
A customer places an order for a service, and has opted to pay you using flexible billing terms instead of the default payment terms chosen at the time of placing the order.
Example URL
Here's an example of the resource URL:
PATCHfscmRestApi/resources/11.13.18.05/receivablesInvoices/<CustomerTransactionId>cURL Command
curl --user <username>:<password> -X PATCH -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" --data @update_installment_payload.json https://<host>:<port>/fscmRestApi/resources/<version>/receivablesInvoices/<CustomerTransactionId>
Example Request
Here's an example of the request body in JSON format:
{
"receivablesInvoiceInstallments":
[
{
"InstallmentId": 321956,
"OriginalAmount": 459,
"InstallmentDueDate": "2018-03-20"
},
{
"InstallmentId": 321957,
"OriginalAmount": 399,
"InstallmentDueDate": "2018-04-19"
}
]
}
Example Response
Here's an example of the response body in JSON format:
{
"CustomerTransactionId": 300100169169047,
"DueDate": "2018-02-20",
"ConversionDate": null,
"ConversionRate": null,
"InvoiceCurrencyCode": "USD",
"SpecialInstructions": null,
"CrossReference": null,
"DocumentNumber": null,
"TransactionNumber": "864",
"TransactionDate": "2018-02-20",
"TransactionType": "Invoice",
"TransactionSource": "Manual-NES",
"BillToCustomerNumber": "1008",
"BillToSite": "Foster City (OPS)",
"Comments": "New Laptop Promotion",
"InternalNotes": "Best Priced item",
"PaymentTerms": "30/60/90",
"LegalEntityIdentifier": "USSYS12030",
"ConversionRateType": null,
"PurchaseOrder": null,
"PurchaseOrderDate": null,
"PurchaseOrderRevision": null,
"FirstPartyRegistrationNumber": "4567890",
"ThirdPartyRegistrationNumber": null,
"InvoicingRule": null,
"ShipToCustomerName": "Total Internet",
"ShipToCustomerNumber": "1008",
"BillingDate": "2018-02-20",
"BusinessUnit": "Vision Operations",
"InvoiceStatus": "Complete",
"AccountingDate": "2018-02-20",
"ShipToSite": "1042",
"PayingCustomerName": "Total Internet",
"PayingCustomerSite": "Foster City (OPS)",
"BillToCustomerName": "Total Internet",
"FreightAmount": null,
"Carrier": null,
"ShipDate": null,
"ShippingReference": null,
"BillToContact": null,
"ShipToContact": null,
"PrintOption": "Yes",
"CreatedBy": "AR_MGR_OPERATIONS",
"CreationDate": "2018-11-23T08:53:33.019+00:00",
"LastUpdatedBy": "AR_MGR_OPERATIONS",
"LastUpdateDate": "2018-11-23T09:22:18+00:00",
"PayingCustomerAccount": "1008",
"SoldToPartyNumber": "1008",
"RemitToAddress": "ZD, Park Avenue St",
"DefaultTaxationCountry": "US",
"EnteredAmount": 1299.99,
"InvoiceBalanceAmount": 1299.99,
"Prepayment": "No",
"Intercompany": "No",
"DocumentFiscalClassification": null,
"BankAccountNumber": null,
"CreditCardAuthorizationRequestIdentifier": null,
"CreditCardExpirationDate": null,
"CreditCardIssuerCode": null,
"CreditCardTokenNumber": null,
"CreditCardVoiceAuthorizationCode": null,
"CreditCardErrorCode": null,
"CreditCardErrorText": null,
"CardHolderLastName": null,
"CardHolderFirstName": null,
"ReceiptMethod": null,
"SalesPersonNumber": null,
"StructuredPaymentReference": null,
"receivablesInvoiceInstallments": [
{
"InstallmentId": 321956,
"InstallmentSequenceNumber": 1,
"InstallmentDueDate": "2018-03-20",
"OriginalAmount": 459,
"PaymentDaysLate": 246,
"InstallmentBalanceDue": 459,
"InstallmentStatus": "Open",
"DisputeAmount": null,
"DisputeDate": null,
"InstallmentClosedDate": "4712-12-31",
"InstallmentGLClosedDate": "4712-12-31",
"AccountedBalanceDue": 459,
"InstallmentAmountAdjusted": null,
"InstallmentAmountCredited": null,
"AmountPaid": null,
"PendingAdjustmentAmount": null,
"InstallmentLineAmountOriginal": 459,
"InstallmentLineAmountDue": 459,
"InstallmentFreightAmountOriginal": 0,
"InstallmentFreightAmountDue": 0,
"InstallmentTaxAmountOriginal": 0,
"InstallmentTaxAmountDue": 0,
"CreationDate": "2018-11-23T09:19:59+00:00",
"CreatedBy": "AR_MGR_OPERATIONS",
"LastUpdateDate": "2018-11-23T09:22:18.006+00:00",
"LastUpdatedBy": "AR_MGR_OPERATIONS",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321956",
"name": "receivablesInvoiceInstallments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321956",
"name": "receivablesInvoiceInstallments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047",
"name": "receivablesInvoices",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321956/child/receivablesInvoiceInstallmentGDF",
"name": "receivablesInvoiceInstallmentGDF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321956/child/receivablesInvoiceInstallmentNotes",
"name": "receivablesInvoiceInstallmentNotes",
"kind": "collection"
}
]
},
{
"InstallmentId": 321957,
"InstallmentSequenceNumber": 2,
"InstallmentDueDate": "2018-04-19",
"OriginalAmount": 399,
"PaymentDaysLate": 216,
"InstallmentBalanceDue": 399,
"InstallmentStatus": "Open",
"DisputeAmount": null,
"DisputeDate": null,
"InstallmentClosedDate": "4712-12-31",
"InstallmentGLClosedDate": "4712-12-31",
"AccountedBalanceDue": 399,
"InstallmentAmountAdjusted": null,
"InstallmentAmountCredited": null,
"AmountPaid": null,
"PendingAdjustmentAmount": null,
"InstallmentLineAmountOriginal": 399,
"InstallmentLineAmountDue": 399,
"InstallmentFreightAmountOriginal": 0,
"InstallmentFreightAmountDue": 0,
"InstallmentTaxAmountOriginal": 0,
"InstallmentTaxAmountDue": 0,
"CreationDate": "2018-11-23T09:19:59+00:00",
"CreatedBy": "AR_MGR_OPERATIONS",
"LastUpdateDate": "2018-11-23T09:22:18.013+00:00",
"LastUpdatedBy": "AR_MGR_OPERATIONS",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321957",
"name": "receivablesInvoiceInstallments",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321957",
"name": "receivablesInvoiceInstallments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047",
"name": "receivablesInvoices",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321957/child/receivablesInvoiceInstallmentGDF",
"name": "receivablesInvoiceInstallmentGDF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments/321957/child/receivablesInvoiceInstallmentNotes",
"name": "receivablesInvoiceInstallmentNotes",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047",
"name": "receivablesInvoices",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B78"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047",
"name": "receivablesInvoices",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/transactionSources",
"name": "transactionSources",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/businessUnits",
"name": "businessUnits",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/PaymentTermsVA",
"name": "PaymentTermsVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/thirdPartyTaxRegistrationNumbers",
"name": "thirdPartyTaxRegistrationNumbers",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/invoiceStatuses",
"name": "invoiceStatuses",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/shipToCustomers",
"name": "shipToCustomers",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/billToCustomers",
"name": "billToCustomers",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/legalEntities",
"name": "legalEntities",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/invoicingRules",
"name": "invoicingRules",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/billToSites",
"name": "billToSites",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/taxationCountries",
"name": "taxationCountries",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/firstPartyTaxRegistrationNumbers",
"name": "firstPartyTaxRegistrationNumbers",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/lov/transactionTypes",
"name": "transactionTypes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceLines",
"name": "receivablesInvoiceLines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceTransactionDFF",
"name": "receivablesInvoiceTransactionDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceGdf",
"name": "receivablesInvoiceGdf",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceInstallments",
"name": "receivablesInvoiceInstallments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/receivablesInvoiceDFF",
"name": "receivablesInvoiceDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receivablesInvoices/300100169169047/child/notes",
"name": "notes",
"kind": "collection"
}
]
}