POST Allocation/SaveBatch

Saves the batch of Allocations.

Request Information

URI Parameters

None.

Body Parameters

The Allocations.

Collection of Allocation
NameTypeAdditional informationDescription
ID integer

None.

DocumentHeaderId_Source integer

None.

Deprecated. Use SourceDocumentId.

DocumentHeaderId_Allocation integer

None.

Deprecated. Use AllocatedToDocumentId.

SourceDocumentId integer

None.

The source document must be one of the following: Receipt, Return or Write-Off (or another transaction that decreases the customers balance).

AllocatedToDocumentId integer

None.

This must be an invoice (or another transaction that increases the customers balance).

Total decimal

None.

The Total will default to 0 if not specified.

Discount decimal

None.

The Discount will default to 0 if not specified.

Type nullable integer

None.

Modified nullable date

Read Only / System Generated

Created nullable date

Read Only / System Generated

Request Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "DocumentHeaderId_Source": 4,
    "DocumentHeaderId_Allocation": 5,
    "SourceDocumentId": 4,
    "AllocatedToDocumentId": 5,
    "Total": 6.0,
    "Discount": 7.0,
    "Type": 1,
    "Modified": "2024-03-28",
    "Created": "2024-03-28"
  },
  {
    "ID": 1,
    "DocumentHeaderId_Source": 4,
    "DocumentHeaderId_Allocation": 5,
    "SourceDocumentId": 4,
    "AllocatedToDocumentId": 5,
    "Total": 6.0,
    "Discount": 7.0,
    "Type": 1,
    "Modified": "2024-03-28",
    "Created": "2024-03-28"
  }
]

Response Information

Resource Description

Collection of Allocation
NameTypeAdditional informationDescription
ID integer

None.

DocumentHeaderId_Source integer

None.

Deprecated. Use SourceDocumentId.

DocumentHeaderId_Allocation integer

None.

Deprecated. Use AllocatedToDocumentId.

SourceDocumentId integer

None.

The source document must be one of the following: Receipt, Return or Write-Off (or another transaction that decreases the customers balance).

AllocatedToDocumentId integer

None.

This must be an invoice (or another transaction that increases the customers balance).

Total decimal

None.

The Total will default to 0 if not specified.

Discount decimal

None.

The Discount will default to 0 if not specified.

Type nullable integer

None.

Modified nullable date

Read Only / System Generated

Created nullable date

Read Only / System Generated

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "DocumentHeaderId_Source": 4,
    "DocumentHeaderId_Allocation": 5,
    "SourceDocumentId": 4,
    "AllocatedToDocumentId": 5,
    "Total": 6.0,
    "Discount": 7.0,
    "Type": 1,
    "Modified": "2024-03-28",
    "Created": "2024-03-28"
  },
  {
    "ID": 1,
    "DocumentHeaderId_Source": 4,
    "DocumentHeaderId_Allocation": 5,
    "SourceDocumentId": 4,
    "AllocatedToDocumentId": 5,
    "Total": 6.0,
    "Discount": 7.0,
    "Type": 1,
    "Modified": "2024-03-28",
    "Created": "2024-03-28"
  }
]