# 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.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.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.CreditNote` (string, required)
    Notes: Notes attached to the credit (mandatory).

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

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

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

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

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

  - `brmObjects.CreditCardExpDate` (string)
    CreditCardExpDate

  - `brmObjects.CreditCardNumber` (string)
    CreditCardNumber

  - `brmObjects.CreditCardCCV` (string)
    CreditCardCCV

  - `brmObjects.InvoiceDetail` (integer)
    InvoiceDetail

  - `brmObjects.VoidCreditId` (integer)
    Voided By

  - `brmObjects.VoidedCreditId` (integer)
    Voided To

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

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

  - `brmObjects.ApprovalStatus` (string)
    Approval Status

  - `brmObjects.ApprovalNotes` (string)
    Approval Notes

  - `brmObjects.AutoApproved` (integer)
    Auto Approved

  - `brmObjects.ApprovalRejectedNote` (string)
    ApprovalRejectedNote

  - `brmObjects.AccountProductId` (integer)
    AccountProductId

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

  - `brmObjects.UnassignedCreditNote` (string)
    UnassignedCreditNote

  - `brmObjects.VoidFlag` (string)
    Void Transaction

  - `brmObjects.AccountingPeriodId` (integer)
    Accounting Period

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

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

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

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

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

  - `brmObjects.EcreditStatus` (integer)
    E-invoicing Status

  - `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.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.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.CreditNote` (string)
    Notes: Notes attached to the credit (mandatory).

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

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

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

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

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

  - `retrieveResponse.CreditCardExpDate` (string)
    CreditCardExpDate

  - `retrieveResponse.CreditCardNumber` (string)
    CreditCardNumber

  - `retrieveResponse.CreditCardCCV` (string)
    CreditCardCCV

  - `retrieveResponse.InvoiceDetail` (integer)
    InvoiceDetail

  - `retrieveResponse.VoidCreditId` (integer)
    Voided By

  - `retrieveResponse.VoidedCreditId` (integer)
    Voided To

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

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

  - `retrieveResponse.ApprovalStatus` (string)
    Approval Status

  - `retrieveResponse.ApprovalNotes` (string)
    Approval Notes

  - `retrieveResponse.AutoApproved` (integer)
    Auto Approved

  - `retrieveResponse.ApprovalRejectedNote` (string)
    ApprovalRejectedNote

  - `retrieveResponse.AccountProductId` (integer)
    AccountProductId

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

  - `retrieveResponse.UnassignedCreditNote` (string)
    UnassignedCreditNote

  - `retrieveResponse.VoidFlag` (string)
    Void Transaction

  - `retrieveResponse.AccountingPeriodId` (integer)
    Accounting Period

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

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

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

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

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

  - `retrieveResponse.EcreditStatus` (integer)
    E-invoicing Status

  - `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