Skip to main content

PaymentAllocation

The amount of one payment applied to one invoice.

type PaymentAllocation {
amount: Float!
appliedFromAdvance: Boolean
createdAt: DateTime!
id: ID!
invoiceId: ID!
invoiceNumber: String
invoiceStatus: String
paymentDate: DateTime
paymentId: ID!
paymentMethod: String
paymentNumber: String
reversalOfId: ID
reversedAt: DateTime
}

Fields​

PaymentAllocation.amount ● Float! non-null scalar​

The amount applied to the invoice. Negative on the counter-entry that reverses an earlier allocation.

PaymentAllocation.appliedFromAdvance ● Boolean scalar​

True when the allocation was applied after the payment was created, settling an invoice from cash held on account.

PaymentAllocation.createdAt ● DateTime! non-null scalar​

When the allocation was created.

PaymentAllocation.id ● ID! non-null scalar​

Unique identifier of the record.

PaymentAllocation.invoiceId ● ID! non-null scalar​

The ID of the invoice the amount was applied to.

PaymentAllocation.invoiceNumber ● String scalar​

The number of the invoice the amount was applied to.

PaymentAllocation.invoiceStatus ● String scalar​

The status of the invoice the amount was applied to.

PaymentAllocation.paymentDate ● DateTime scalar​

The date of the payment.

PaymentAllocation.paymentId ● ID! non-null scalar​

The ID of the payment this allocation belongs to.

PaymentAllocation.paymentMethod ● String scalar​

How the payment was made.

PaymentAllocation.paymentNumber ● String scalar​

The number of the payment this allocation belongs to.

PaymentAllocation.reversalOfId ● ID scalar​

On a reversal counter-entry, the ID of the allocation it reverses.

PaymentAllocation.reversedAt ● DateTime scalar​

When the allocation was reversed. Null if it was not.

Member Of​

Invoice object ● Payment object