FIfireserviceusa
Job

Void AR Invoice - Creates Reversing Credit Memo

Changed on
put/api/v1/Jobs/Transactions/AR/Void

Request

  • Base URL
    https://api.fireserviceusa.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.fireserviceusa.com/api/v1/Jobs/Transactions/AR/Void
  • Auth
    none declared

Request body

ArTrxIdinteger
ArTrxTypestring required

Invoice, Credit Memo, Write Off

JobIdinteger required
AccountIdinteger required
GpDocNumberstring nullable
GpDocTypeinteger
GpCustomerstring nullable
ArTrxDatestring date-time required
ArTrxDescstring nullable
ArTrxTotalnumber double
Approvedboolean
Submittedboolean
Voidedboolean
Reconciledboolean
CreateDatestring date-time
CreateUserstring nullable
UpdateDatestring date-time
UpdateUserstring nullable
CareOfstring nullable
PaidAmountnumber double
FullyPaidDatestring date-time
FullyPaidboolean
CashReceiptsstring nullable
PaymentUpdateLogstring nullable
UsedForLoyaltyRewardsboolean

Indicates whether this invoice has been used to calculate loyalty rewards

LoyaltyRewardReferringEntityIdinteger nullable

The referring entity ID used for "Credit Memo - Loyalty Rewards" transactions Links the credit memo to the specific referring entity whose loyalty rewards balance was used

CreditMemoReasonCodeIdinteger nullable

The reason code ID for Credit Memo and Credit Memo - Loyalty Rewards transactions

OnlinePaymentEnabledboolean
WaiveCCFeeboolean
AllowManualBankEntryboolean
LastPaymentReminderSentstring date-time nullable
PaymentReminderCountinteger
AmountDuenumber double
HasOutstandingBalanceboolean
IsInvoiceboolean
IsPartiallyPaidboolean
OriginalAmountnumber double
RemainingAmountnumber double

Response

Success

Changes

  • 37e82a6289ecRevision changes
    • info

      added the new optional request property /// (media type: application/json-patch+json)

    • info

      added the new optional request property /// (media type: application/json)

    • info

      added the new optional request property /// (media type: text/json)

    • info

      added the new optional request property /// (media type: application/*+json)

    • info

      added the new optional request property ///// (media type: application/json-patch+json)

    • info

      added the new optional request property ///// (media type: application/json)

    • info

      added the new optional request property ///// (media type: text/json)

    • info

      added the new optional request property ///// (media type: application/*+json)

  • 91cbb088c4b1Revision changes
    • info

      added the new optional request property ////// (media type: application/json-patch+json)

    • info

      added the new optional request property ////// (media type: application/json)

    • info

      added the new optional request property ////// (media type: text/json)

    • info

      added the new optional request property ////// (media type: application/*+json)

    • info

      added the new optional request property // (media type: application/json-patch+json)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: text/json)

    • info

      added the new optional request property // (media type: application/*+json)

    • info

      added the new optional request property //////// (media type: application/json-patch+json)

    • info

      added the new optional request property //////// (media type: application/json)

    • info

      added the new optional request property //////// (media type: text/json)

    • info

      added the new optional request property //////// (media type: application/*+json)

    • info

      added the new optional request property //// (media type: application/json-patch+json)

    • info

      added the new optional request property //// (media type: application/json)

    • info

      added the new optional request property //// (media type: text/json)

    • info

      added the new optional request property //// (media type: application/*+json)