Rebate Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Rebate Management Standard Objects
AccountAccountRelation
PartyRoleRelation
ProgramRebateType
ProgramRebateTypeBenefit
PgmRebateTypBnftMapping
ProgramRebateTypeFilter
ProgramRebateTypePayout
ProgramRebateTypPayoutSrc
ProgramRebateTypeProduct
ProgramRebateTypeReference
RebateClaim
RebateClaimAdjustment
RebateMemberAggregateItem
RebateMemberClaimAggregate
RebateMemberProductAggregate
RebatePartnerSpecialPrcTrm
RebatePayment
RebatePayoutAdjustment
RebateProgram
RebateProgramMember
RebateProgramMemberPayout
RebateProgramPayoutPeriod
RebatePtnrSpclPrcTrmBnft
ReceivedDocument
TransactionJournal
UnitOfMeasureConversion
Rebate Management Standard Invocable Actions
Rebate Management Metadata API Types
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

RebateClaim

Represents information about the claim submitted by the end customer or distributor for a ship and debit program. This object is available in API version 54.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
ApprovedAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The approved rebate claim amount. Available in API version 58.0 and later.
CalculatedAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The calculated rebate claim amount. Available in API version 58.0 and later.
ClaimAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The amount for which rebate is claimed.
ClaimDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date when the claim is submitted by the claimant.
ClaimType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of the rebate claim. Available in API version 58.0 and later.
Possible values are:
  • ShipAndDebit—Ship and Debit
  • StandardRebate—Standard Rebate
The default value is StandardRebate.
ClaimedByAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account of the customer or distributor who is submitting the claim.
This field is a relationship field.
Relationship Name
ClaimedByAccount
Relationship Type
Lookup
Refers To
Account
ClaimedByAccountNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reference number of the account of the customer or distributor who is submitting the claim.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If multiple currencies are enabled, this field contains the currency ISO code associated with the record.
Possible values are:
  • EUR—Euro
  • USD—U.S. Dollar
The default value is EUR.
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The description of the rebate claim.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed this record.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Autogenerated name of the rebate claim.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the rebate claim record owner.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ParticipatingAccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account of a participant in the claim. It can be the ship to/end customer or shipper/ channel partner.
This field is a relationship field.
Relationship Name
ParticipatingAccount
Relationship Type
Lookup
Refers To
Account
ParticipatingAccountNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reference number of the account of a participant in the claim. It can be the ship to/end customer or shipper/ channel partner.
ProcessingStatus
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The processing status of the rebate claim.
Possible values are:
  • Approved
  • Complete
  • In Review
  • New
  • Rejected
  • Reviewed
  • System Failed
  • System Processed
The default value is New.
ProcessingStatusMessage
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
The message with the details of the rebate claim’s processing status when it isn’t completed.
ProductCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reference number of the product for which the rebate claim is submitted.
ProductId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The product for which the rebate claim is submitted.
This field is a relationship field.
Relationship Name
Product
Relationship Type
Lookup
Refers To
Product2
ProgramReferenceNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reference number of the rebate program.
Quantity
Type
double
Properties
Create, Filter, Sort, Update
Description
The quantity of the product for which the rebate claim is submitted.
QuantityUnitOfMeasureId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unit of measure of the quantity. Available in API version 58.0 and later.
Relationship Name
QuantityUnitOfMeasure
Relationship Type
Lookup
Refers To
UnitOfMeasure
RebateMemberClaimAggregateId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The rebate member claim aggregate record related to the rebate claim. Available in API version 58.0 and later.
Relationship Name
RebateMemberClaimAggregate
Relationship Type
Lookup
Refers To
RebateMemberClaimAggregate
RebatePaymentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The rebate payment record related to the rebate claim. Available in API version 58.0 and later.
Relationship Name
RebatePayment
Relationship Type
Lookup
Refers To
RebatePayment
ReceivedDocumentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The received document that this claim is part of. Available in API version 58.0 and later.
Relationship Name
ReceivedDocument
Relationship Type
Lookup
Refers To
ReceivedDocument
ReferencePricePerUnit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The price of a product unit that’s agreed upon between the manufacturer and the claimant by the manufacturer and the distributor or the manufacturer and the customer for the rebate claim.
ResalePricePerUnit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The price at which the claimant bought the product.
SalePricePerUnit
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The original price at which a product unit is sold to the customer by the manufacturer.
ShipDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date when the product was shipped to end customer. Available in API version 58.0 and later.
ShippedTransactionIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier of the transaction between distributor and end customer or ship to account. Available in API version 58.0 and later.
TotalAdjustmentAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The total amount adjusted on the rebate claim. Available in API version 58.0 and later.
TransactionIdentifier
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique identifier of the transaction between the manufacturer and distributor. Available in API version 58.0 and later.
UsageType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Specifies the usage type of the rebate claim.
Possible value is:
  • Rebates
The default value is Rebates. Available in API version 58.0 and later.