API Reference
officernd.comSupportAdmin PortalBecome a Partner

Create a new allocation for credit note/overpayment

post
https://app.officernd.com/api/v2/organizations//payments//allocations

Create a new allocation for a credit note/overpayment.
The paymentId used here is the id of the credit note/overpayment, while the request body contains the id of the target invoice.

Required scopes: flex.billing.payments.allocations.create

Path Params
string
required

overpayment/credit note id

string
required

organization slug

Body Params
string
required

If payment is an invoice, a reference to the credit note, sourcing the credit.
If payment is a credit note, a reference to the invoice the credit is allocated to.

number
required

The allocated amount.

accounting
object

The accounting data for the allocation.

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?