AllocatetoInvoice
Allocates a document (for example, credit note or payment) against an invoice. This is useful for ensuring that payments or credit notes are correctly applied to outstanding invoices.
Input
| Name | Type | Required | Description |
| Type | String | True | Specifies the type of document being allocated. This could refer to a particular classification of document, such as an invoice or credit note, used to determine how the allocation is processed.
The allowed values are CreditNotes, Overpayments, Prepayments. |
| DocumentId | String | True | The unique identifier for the document that is being allocated. This ID helps link the document to its relevant financial transaction or record. |
| InvoiceId | String | True | The unique identifier for the invoice that this document is being allocated against. This ties the document allocation to a specific invoice. |
| AppliedAmount | String | True | The amount of money being allocated to the invoice. This is the value that will be applied to reduce the outstanding balance on the specified invoice. |
| TenantId | String | False | The unique identifier for the tenant. This allows the system to query data specific to a tenant other than the default connection tenant, useful in multi-tenant environments. |
| Date | String | False | The date when the overpayment is applied. This marks the time at which the funds are officially allocated, which may be important for accounting and reporting purposes. |
Result Set Columns
| Name | Type | Description |
| Success | String | A boolean value indicating the outcome of the operation. 'True' means the allocation was successfully processed, while 'false' indicates that an error occurred during the process. |