Billing

Add a payment to an invoice.

If the amount matches the outstanding amount of the invoice, the invoice will be marked as Paid.

post/api/v1/billing/transactions/payment

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/billing/transactions/payment
Auth: one of:
- HTTP bearer
- API key in header Authorization

Request body

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

TransactionDatestring date-time

BillingTransactionType1 | 2 | 3 | 4 | 5 | 6

1 - Invoice, 2 - Payment, 3 - Credit, 4 - Refund, 5 - Chargeback, 6 - TaxRefund

Amountnumber

IsCapturedboolean

IsElectronicTransactionboolean

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "TransactionDate": "string",
  "BillingTransactionType": 1,
  "Account": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "StripeId": "string",
    "IsLivemode": false,
    "Name": "string",
    "ClientIdentifier": "string",
    "Currency": "string",
    "InvoiceNotes": "string",
    "IsDemo": false,
    "BillingAddress": {},
    "MailingAddress": {},
    "AccountStage": 2,
    "PaymentInformation": {},
    "PersonAccount": [],
    "StripeDefaultPaymentMethodId": "string",
    "StripeInvoices": [],
    "StripePaymentMethods": [],
    "StripeSubscriptions": [],
    "Subscriptions": [],
    "Deals": [],
    "LastLoginDateTime": "string",
    "AccountSpecificPageUrl1": "string",
    "AccountSpecificPageUrl2": "string",
    "AccountSpecificPageUrl3": "string",
    "AccountSpecificPageUrl4": "string",
    "AccountSpecificPageUrl5": "string",
    "AccountSpecificPageUrl6": "string",
    "AccountSpecificPageUrl7": "string",
    "AccountSpecificPageUrl8": "string",
    "AccountSpecificPageUrl9": "string",
    "AccountSpecificPageUrl10": "string",
    "RewardFulReferralId": "string",
    "ToltReferralId": "string",
    "TaxIds": [],
    "TaxStatus": "string",
    "AccountStageLabel": "string",
    "CurrentStripeProducts": "string",
    "CurrentStripeProductInstances": [],
    "CurrentSubscription": {},
    "DomainName": "string",
    "TenantBillingSystem": 1,
    "HasLoggedIn": false,
    "LatestSubscription": {},
    "LifetimeRevenue": 0,
    "NextStripeInvoiceDate": "string",
    "Nonce": "string",
    "PrimaryContact": {},
    "PrimarySubscription": {},
    "PrimaryStripeSubscription": {},
    "RecaptchaToken": "string",
    "StripeCheckoutMetadata": {},
    "StripeNextInvoiceSequence": 0,
    "StripePrice": [],
    "StripePriceIds": "string",
    "StripePromotionCode": "string",
    "TaxId": "string",
    "TaxIdIsInvalid": false,
    "TaxIdType": "string",
    "WebflowSlug": "string"
  },
  "Invoice": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "InvoiceDate": "string",
    "PaymentReminderSentDate": "string",
    "Number": 0,
    "BillingInvoiceStatus": 1,
    "Subscription": {},
    "Amount": 0,
    "AmountOutstanding": 0,
    "InvoiceLineItems": [],
    "IsUserGenerated": false,
    "StripeTaxCalculationId": "string",
    "StripeTaxBehavior": "string",
    "AmountCredit": 0,
    "AmountDiscount": 0,
    "AmountPaid": 0,
    "AmountRefunded": 0,
    "AmountSubtotal": 0,
    "AmountTax": 0,
    "AmountTaxRefunded": 0,
    "IsTaxable": false,
    "HasPaymentGatewayTransactions": false,
    "StripePaymentTransactionIds": "string",
    "StripeRefundTransactionIds": "string",
    "StripeTaxRefundTransactionIds": "string"
  },
  "Amount": 0,
  "IsCaptured": false,
  "IsElectronicTransaction": false
}

Response