POST v1/Debits
Documentation for 'Post'.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
debit | Documentation for 'debit'. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
Click to beautify!
{ "reference": "sample string 1", "effectiveTimestamp": "2024-05-03T08:19:40.649458+00:00", "originalCreditId": 2, "amount": 3.0, "debitAllocations": [ { "invoiceId": 1, "amount": 2.0 }, { "invoiceId": 1, "amount": 2.0 }, { "invoiceId": 1, "amount": 2.0 } ] }
application/xml, text/xml
Sample:
Click to beautify!
<Debit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Post"> <Amount>3</Amount> <DebitAllocations> <RefundAllocation> <Amount>2</Amount> <InvoiceId>1</InvoiceId> </RefundAllocation> <RefundAllocation> <Amount>2</Amount> <InvoiceId>1</InvoiceId> </RefundAllocation> <RefundAllocation> <Amount>2</Amount> <InvoiceId>1</InvoiceId> </RefundAllocation> </DebitAllocations> <EffectiveTimestamp>2024-05-03T08:19:40.649458+00:00</EffectiveTimestamp> <OriginalCreditId>2</OriginalCreditId> <Reference>sample string 1</Reference> </Debit>
application/x-www-form-urlencoded
Sample:
Click to beautify!
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
Click to beautify!
{ "reference": "sample string 1", "effectiveTimestamp": "2024-05-03T08:19:40.6651259+00:00", "description": "sample string 3", "customerId": 4, "originalCreditId": 5, "amount": 6.0, "currency": "sample string 7", "invoiceAllocations": [ { "invoiceId": 1, "invoiceNumber": 2, "amount": 3.0, "outstandingBalance": 4.0, "invoiceTotal": 5.0, "surchargingFee": 1.0, "poNumber": "sample string 6", "netsuiteId": "sample string 7", "quickbooksId": 1, "invoiceNote": "sample string 8", "uri": "sample string 9" }, { "invoiceId": 1, "invoiceNumber": 2, "amount": 3.0, "outstandingBalance": 4.0, "invoiceTotal": 5.0, "surchargingFee": 1.0, "poNumber": "sample string 6", "netsuiteId": "sample string 7", "quickbooksId": 1, "invoiceNote": "sample string 8", "uri": "sample string 9" }, { "invoiceId": 1, "invoiceNumber": 2, "amount": 3.0, "outstandingBalance": 4.0, "invoiceTotal": 5.0, "surchargingFee": 1.0, "poNumber": "sample string 6", "netsuiteId": "sample string 7", "quickbooksId": 1, "invoiceNote": "sample string 8", "uri": "sample string 9" } ], "trigger": "sample string 8", "triggeringUserId": 1, "triggerUsername": "sample string 9", "quickBooksId": 1, "quickBooksAttemptNumber": 10, "id": 11, "uri": "sample string 12" }
application/xml, text/xml
Sample:
Click to beautify!
<Debit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get"> <Id>11</Id> <Uri>sample string 12</Uri> <Amount>6</Amount> <Currency>sample string 7</Currency> <CustomerId>4</CustomerId> <Description>sample string 3</Description> <EffectiveTimestamp>2024-05-03T08:19:40.6651259+00:00</EffectiveTimestamp> <InvoiceAllocations> <InvoiceAllocation> <Amount>3</Amount> <InvoiceId>1</InvoiceId> <InvoiceNote>sample string 8</InvoiceNote> <InvoiceNumber>2</InvoiceNumber> <InvoiceTotal>5</InvoiceTotal> <NetsuiteId>sample string 7</NetsuiteId> <OutstandingBalance>4</OutstandingBalance> <PoNumber>sample string 6</PoNumber> <QuickbooksId>1</QuickbooksId> <SurchargingFee>1</SurchargingFee> <Uri>sample string 9</Uri> </InvoiceAllocation> <InvoiceAllocation> <Amount>3</Amount> <InvoiceId>1</InvoiceId> <InvoiceNote>sample string 8</InvoiceNote> <InvoiceNumber>2</InvoiceNumber> <InvoiceTotal>5</InvoiceTotal> <NetsuiteId>sample string 7</NetsuiteId> <OutstandingBalance>4</OutstandingBalance> <PoNumber>sample string 6</PoNumber> <QuickbooksId>1</QuickbooksId> <SurchargingFee>1</SurchargingFee> <Uri>sample string 9</Uri> </InvoiceAllocation> <InvoiceAllocation> <Amount>3</Amount> <InvoiceId>1</InvoiceId> <InvoiceNote>sample string 8</InvoiceNote> <InvoiceNumber>2</InvoiceNumber> <InvoiceTotal>5</InvoiceTotal> <NetsuiteId>sample string 7</NetsuiteId> <OutstandingBalance>4</OutstandingBalance> <PoNumber>sample string 6</PoNumber> <QuickbooksId>1</QuickbooksId> <SurchargingFee>1</SurchargingFee> <Uri>sample string 9</Uri> </InvoiceAllocation> </InvoiceAllocations> <OriginalCreditId>5</OriginalCreditId> <QuickBooksAttemptNumber>10</QuickBooksAttemptNumber> <QuickBooksId>1</QuickBooksId> <Reference>sample string 1</Reference> <Trigger>sample string 8</Trigger> <TriggerUsername>sample string 9</TriggerUsername> <TriggeringUserId>1</TriggeringUserId> </Debit>