# Save Credits

Save Credits

Endpoint: POST /rest/2.0/CREDIT
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.CreditNote` (string, required)
    Notes: Notes attached to the credit (mandatory).

  - `brmObjects.ApprovalStatus` (string)
    Approval Status

  - `brmObjects.AutoCreditDiscount` (integer)
    Auto-Credit Discount Hidden

  - `brmObjects.Id` (string, required)
    Credit Item ID

  - `brmObjects.CreditDate` (string)
    Credit Date: Select the financial date of the credit. This field will be used to categorize the credit into an accounting period in certain cases based on the Accounting Period configuration

  - `brmObjects.AccountingPeriodId` (integer)
    Accounting Period

  - `brmObjects.VoidFlag` (string)
    Void Transaction

  - `brmObjects.BillingProfileId` (string, required)
    Billing Profile Id: ACCOUNT NUMBER

  - `brmObjects.VoidCreditId` (integer)
    Voided By

  - `brmObjects.TaxEngineRequestId` (integer)
    Tax Audit Log

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.Autoallocate` (integer)
    Auto-allocate: Once created, credits can be allocated to invoices to offset the balance due.  Auto-allocate ON: The credit will be allocated to the invoice from which the credit line items were created first (up to the balance due), and then to other invoices based on their due date (oldest first).Auto-allocate OFF: You can allocate the credit manually using the allocation table located below the credit line item table

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.VoidedCreditId` (integer)
    Voided To

  - `brmObjects.UnassignedCreditNote` (string)
    UnassignedCreditNote

  - `brmObjects.ApproveRejectedUser` (integer)
    Approved/Rejected By

  - `brmObjects.AutoCreditTax` (integer)
    Auto-Credit Tax Hidden

  - `brmObjects.CreditType` (string, required)
    Credit Type: Reason why the credit was given

  - `brmObjects.ApprovalNotes` (string)
    Approval Notes

  - `brmObjects.AutoCreditAssociatedProduct` (integer)
    Auto-Credit Product Hidden

  - `brmObjects.SourceRefundId` (integer)
    Source Refund Id

  - `brmObjects.ApprovedRejectedDate` (string)
    Approved/Rejected Date

  - `brmObjects.AutoApproved` (integer)
    Auto Approved

  - `brmObjects.InvoiceIdDisplay` (string)
    InvoiceIdDisplay: Displayed on the invoice

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.CreditCardExpDate` (string)
    CreditCardExpDate

  - `brmObjects.CreditCardNumber` (string)
    CreditCardNumber

  - `brmObjects.CreditCardCCV` (string)
    CreditCardCCV

  - `brmObjects.InvoiceDetail` (integer)
    InvoiceDetail

  - `brmObjects.ApprovalRejectedNote` (string)
    ApprovalRejectedNote

  - `brmObjects.AccountProductId` (integer)
    AccountProductId

  - `brmObjects.CreditCardName` (string)
    CreditCardName

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.CreditNote` (string)
    Notes: Notes attached to the credit (mandatory).

  - `retrieveResponse.ApprovalStatus` (string)
    Approval Status

  - `retrieveResponse.AutoCreditDiscount` (integer)
    Auto-Credit Discount Hidden

  - `retrieveResponse.Id` (string)
    Credit Item ID

  - `retrieveResponse.CreditDate` (string)
    Credit Date: Select the financial date of the credit. This field will be used to categorize the credit into an accounting period in certain cases based on the Accounting Period configuration

  - `retrieveResponse.AccountingPeriodId` (integer)
    Accounting Period

  - `retrieveResponse.VoidFlag` (string)
    Void Transaction

  - `retrieveResponse.BillingProfileId` (string)
    Billing Profile Id: ACCOUNT NUMBER

  - `retrieveResponse.VoidCreditId` (integer)
    Voided By

  - `retrieveResponse.TaxEngineRequestId` (integer)
    Tax Audit Log

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.Autoallocate` (integer)
    Auto-allocate: Once created, credits can be allocated to invoices to offset the balance due.  Auto-allocate ON: The credit will be allocated to the invoice from which the credit line items were created first (up to the balance due), and then to other invoices based on their due date (oldest first).Auto-allocate OFF: You can allocate the credit manually using the allocation table located below the credit line item table

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.VoidedCreditId` (integer)
    Voided To

  - `retrieveResponse.UnassignedCreditNote` (string)
    UnassignedCreditNote

  - `retrieveResponse.ApproveRejectedUser` (integer)
    Approved/Rejected By

  - `retrieveResponse.AutoCreditTax` (integer)
    Auto-Credit Tax Hidden

  - `retrieveResponse.CreditType` (string)
    Credit Type: Reason why the credit was given

  - `retrieveResponse.ApprovalNotes` (string)
    Approval Notes

  - `retrieveResponse.AutoCreditAssociatedProduct` (integer)
    Auto-Credit Product Hidden

  - `retrieveResponse.SourceRefundId` (integer)
    Source Refund Id

  - `retrieveResponse.ApprovedRejectedDate` (string)
    Approved/Rejected Date

  - `retrieveResponse.AutoApproved` (integer)
    Auto Approved

  - `retrieveResponse.InvoiceIdDisplay` (string)
    InvoiceIdDisplay: Displayed on the invoice

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.CreditCardExpDate` (string)
    CreditCardExpDate

  - `retrieveResponse.CreditCardNumber` (string)
    CreditCardNumber

  - `retrieveResponse.CreditCardCCV` (string)
    CreditCardCCV

  - `retrieveResponse.InvoiceDetail` (integer)
    InvoiceDetail

  - `retrieveResponse.ApprovalRejectedNote` (string)
    ApprovalRejectedNote

  - `retrieveResponse.AccountProductId` (integer)
    AccountProductId

  - `retrieveResponse.CreditCardName` (string)
    CreditCardName

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error