Skip to content
Moneybird logo moneybird-api-php

Sales Invoice Payments

Manage payments for Sales Invoices in Moneybird.

Working with Sales Invoice Payments

This section covers how to interact with Moneybird’s Sales Invoice Payments API. You can register payments for sales invoices.

Basic Operations

Register a Payment

Register a payment for a specific sales invoice.

$paymentData = [
    'payment_date' => '2023-01-20',
    'price' => '500.00',
    'payment_method' => 'bank_transfer'
];


$payment = $client->salesInvoices()->payments()->registerForSalesInvoiceId('123456789', $paymentData);

Delete a Payment

Delete a payment associated with a sales invoice.

$client->salesInvoices()->deletePayment('123456789', 'payment_id');

Note: The delete payment functionality is available through the SalesInvoicesEndpoint rather than the SalesInvoicePaymentsEndpoint.

Accessing the Payments Endpoint

You can access the payments endpoint through the sales invoices endpoint:

$paymentsEndpoint = $client->salesInvoices()->payments();

Sales Invoice Payment Properties

When working with sales invoice payments, you’ll have access to the following properties:

PropertyTypeDescription
idstringUnique identifier
administration_idstringID of the administration the payment belongs to
invoice_idstringID of the sales invoice the payment is for
payment_datestringDate when the payment was made
pricestringAmount of the payment
price_basestringAmount of the payment in base currency
payment_methodstringMethod of payment (e.g., ‘bank_transfer’, ‘credit_card’, ‘cash’)
created_atstringISO 8601 timestamp of when the payment was created
updated_atstringISO 8601 timestamp of when the payment was last updated

Note: See the official API reference for the complete list of available properties.

Further reading