POST customer/receipt/allocation/advanced

Allocate single or multiple customer receipt or credit memo

Request Information

URI Parameters

None.

Body Parameters

Interprise.Web.Services.Models.CustomerAllocationInput
NameDescriptionTypeAdditional information
CustomerCode

Optional when customer name is specified

string

None.

CustomerName

Optional when customer code is specified

string

None.

Credits

Receivable or credit documents like Credit Memo, Receipt.

Collection of Interprise.Web.Services.Models.CustomerAllocationInput+CreditDetails

None.

Debits

Debit documents like Customer Refund, Invoice.

Collection of Interprise.Web.Services.Models.CustomerAllocationInput+DebitDetails

None.

Request Formats

{
  "customerCode": "sample string 1",
  "customerName": "sample string 2",
  "credits": [
    {
      "receivableCode": "sample string 1",
      "allocatedAmount": 2.0
    },
    {
      "receivableCode": "sample string 1",
      "allocatedAmount": 2.0
    }
  ],
  "debits": [
    {
      "documentCode": "sample string 1",
      "allocatedAmount": 2.0
    },
    {
      "documentCode": "sample string 1",
      "allocatedAmount": 2.0
    }
  ]
}
<CustomerAllocationInput xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerCode>sample string 1</CustomerCode>
  <CustomerName>sample string 2</CustomerName>
  <Credits>
    <CreditDetails>
      <ReceivableCode>sample string 1</ReceivableCode>
      <AllocatedAmount>2</AllocatedAmount>
      <CurrentBalanceToAllocate>3</CurrentBalanceToAllocate>
    </CreditDetails>
    <CreditDetails>
      <ReceivableCode>sample string 1</ReceivableCode>
      <AllocatedAmount>2</AllocatedAmount>
      <CurrentBalanceToAllocate>3</CurrentBalanceToAllocate>
    </CreditDetails>
  </Credits>
  <Debits>
    <DebitDetails>
      <DocumentCode>sample string 1</DocumentCode>
      <AllocatedAmount>2</AllocatedAmount>
      <CurrentBalanceToAllocate>3</CurrentBalanceToAllocate>
    </DebitDetails>
    <DebitDetails>
      <DocumentCode>sample string 1</DocumentCode>
      <AllocatedAmount>2</AllocatedAmount>
      <CurrentBalanceToAllocate>3</CurrentBalanceToAllocate>
    </DebitDetails>
  </Debits>
</CustomerAllocationInput>

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerAllocationInput'.

Response Information

Resource Description

Interprise.Web.Services.Models.CustomerAllocation
NameDescriptionTypeAdditional information
AllocationCode

string

None.

AllocationDate

date

None.

IsPosted

boolean

None.

CustomerCode

string

None.

CustomerName

string

None.

CurrencyCode

string

None.

ExchangeRate

decimal number

None.

Total

decimal number

None.

Credits

Collection of Interprise.Web.Services.Models.CustomerAllocationCreditView

None.

Debits

Collection of Interprise.Web.Services.Models.CustomerAllocationDebitView

None.

Response Formats

{
  "allocationCode": "sample string 1",
  "allocationDate": "2025-04-29T16:09:21.6089096+01:00",
  "isPosted": true,
  "customerCode": "sample string 3",
  "customerName": "sample string 4",
  "currencyCode": "sample string 5",
  "exchangeRate": 1.0,
  "total": 1.0,
  "credits": [
    {
      "allocationCode": "sample string 1",
      "documentAllocatedFromCode": "sample string 2",
      "type": "sample string 3",
      "documentDate": "2025-04-29T16:09:21.6089096+01:00",
      "totalAmount": 1.0,
      "reservedAmount": 1.0,
      "unAppliedAmount": 1.0,
      "allocated": 1.0,
      "exchangeRate": 1.0
    },
    {
      "allocationCode": "sample string 1",
      "documentAllocatedFromCode": "sample string 2",
      "type": "sample string 3",
      "documentDate": "2025-04-29T16:09:21.6089096+01:00",
      "totalAmount": 1.0,
      "reservedAmount": 1.0,
      "unAppliedAmount": 1.0,
      "allocated": 1.0,
      "exchangeRate": 1.0
    }
  ],
  "debits": [
    {
      "allocationCode": "sample string 1",
      "receivableCode": "sample string 2",
      "documentCode": "sample string 3",
      "type": "sample string 4",
      "documentDate": "2025-04-29T16:09:21.6089096+01:00",
      "amount": 1.0,
      "potentialDiscount": 1.0,
      "termsDiscount": "sample string 5",
      "outstandingBalance": 1.0,
      "writeOff": 1.0,
      "allocated": 1.0,
      "tax": 1.0,
      "exchangeRate": 1.0
    },
    {
      "allocationCode": "sample string 1",
      "receivableCode": "sample string 2",
      "documentCode": "sample string 3",
      "type": "sample string 4",
      "documentDate": "2025-04-29T16:09:21.6089096+01:00",
      "amount": 1.0,
      "potentialDiscount": 1.0,
      "termsDiscount": "sample string 5",
      "outstandingBalance": 1.0,
      "writeOff": 1.0,
      "allocated": 1.0,
      "tax": 1.0,
      "exchangeRate": 1.0
    }
  ]
}
<CustomerAllocation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <AllocationCode>sample string 1</AllocationCode>
  <AllocationDate>2025-04-29T16:09:21.6089096+01:00</AllocationDate>
  <IsPosted>true</IsPosted>
  <CustomerCode>sample string 3</CustomerCode>
  <CustomerName>sample string 4</CustomerName>
  <CurrencyCode>sample string 5</CurrencyCode>
  <ExchangeRate>1</ExchangeRate>
  <Total>1</Total>
  <Credits>
    <CustomerAllocationCreditView>
      <AllocationCode>sample string 1</AllocationCode>
      <DocumentAllocatedFromCode>sample string 2</DocumentAllocatedFromCode>
      <Type>sample string 3</Type>
      <DocumentDate>2025-04-29T16:09:21.6089096+01:00</DocumentDate>
      <TotalAmountRate>1</TotalAmountRate>
      <ReservedAmountRate>1</ReservedAmountRate>
      <UnAppliedAmountRate>1</UnAppliedAmountRate>
      <AllocatedRate>1</AllocatedRate>
      <ExchangeRate>1</ExchangeRate>
    </CustomerAllocationCreditView>
    <CustomerAllocationCreditView>
      <AllocationCode>sample string 1</AllocationCode>
      <DocumentAllocatedFromCode>sample string 2</DocumentAllocatedFromCode>
      <Type>sample string 3</Type>
      <DocumentDate>2025-04-29T16:09:21.6089096+01:00</DocumentDate>
      <TotalAmountRate>1</TotalAmountRate>
      <ReservedAmountRate>1</ReservedAmountRate>
      <UnAppliedAmountRate>1</UnAppliedAmountRate>
      <AllocatedRate>1</AllocatedRate>
      <ExchangeRate>1</ExchangeRate>
    </CustomerAllocationCreditView>
  </Credits>
  <Debits>
    <CustomerAllocationDebitView>
      <AllocationCode>sample string 1</AllocationCode>
      <DocumentAllocatedFromCode>sample string 2</DocumentAllocatedFromCode>
      <DocumentAllocatedToCode>sample string 3</DocumentAllocatedToCode>
      <Type>sample string 4</Type>
      <DocumentDate>2025-04-29T16:09:21.6089096+01:00</DocumentDate>
      <AmountRate>1</AmountRate>
      <PotentialDiscountRate>1</PotentialDiscountRate>
      <TermsDiscount>sample string 5</TermsDiscount>
      <OutstandingBalanceRate>1</OutstandingBalanceRate>
      <WriteOffRate>1</WriteOffRate>
      <AllocatedRate>1</AllocatedRate>
      <TaxRate>1</TaxRate>
      <ExchangeRate>1</ExchangeRate>
    </CustomerAllocationDebitView>
    <CustomerAllocationDebitView>
      <AllocationCode>sample string 1</AllocationCode>
      <DocumentAllocatedFromCode>sample string 2</DocumentAllocatedFromCode>
      <DocumentAllocatedToCode>sample string 3</DocumentAllocatedToCode>
      <Type>sample string 4</Type>
      <DocumentDate>2025-04-29T16:09:21.6089096+01:00</DocumentDate>
      <AmountRate>1</AmountRate>
      <PotentialDiscountRate>1</PotentialDiscountRate>
      <TermsDiscount>sample string 5</TermsDiscount>
      <OutstandingBalanceRate>1</OutstandingBalanceRate>
      <WriteOffRate>1</WriteOffRate>
      <AllocatedRate>1</AllocatedRate>
      <TaxRate>1</TaxRate>
      <ExchangeRate>1</ExchangeRate>
    </CustomerAllocationDebitView>
  </Debits>
</CustomerAllocation>