Features V2
Finance feature V2
Allow the Seller to collect all the financial data provided
by the Octopia financial system
API finance Feature
Allows sellers to retrieve all financial informations. Most common operations : payment details, payment overview, operation and invoice details, invoice download. You will be able to :
Search for financial operations
Consult payment summary (estimated and paid)
Consult and download invoices
What is a finance ?
In order to understand what "finance" means for Octopia you can read the help center documentation. You will find :
What is your finance page
How to find commission invoices
What are the payment times for orders
How to export my payment details
How the Finance work
Financial information concerning orders is available the day after the acceptation of the order by the seller.
Sellers can therefore retrieve all the financial information of an order (or refund) at Day +1.
They can also retrieve all financial information available by entering the period filters.
Commission statements are issued every 10 days on 9/19/29 of the month. It is a document of grouping of invoices.
The invoice documents (PDF files) are available at the same time as the invoice information.
Finally, payments are triggered automatically every 10 days on 1/11/21 of the month or on demand as soon as the funds are cleared.
Sellers can retrieve the details of the payments made on each payout, as well as payment history.
Here is an operating diagram of Octopia's financial workflow :
Endpoints
Download an invoice
GET /invoices/{invoiceId}/documents
Call attributes : invoiceid ; sellerid
Response attributes : pdf file
Recommended call frequency : One time after each 10 days (on 9, 19 and 29 of each month). This is because the invoices are generated before the payout.
Count invoice details
GET/invoices/{invoiceId}/details/count
Call attributes : sales channel ; graduation code
Response attributes : count
Recommended call frequency : One time after each 10 days (on 9, 19 and 29 of each month). This is because the invoices are generated before the payout.
Retrieve invoice details
GET /invoices
Call attributes : invoiceid ; sellerid
Response attributes : link
Recommended call frequency : One time after each 10 days (on 9, 19 and 29 of each month). This is because the invoices are generated before the payout.
Download invoices
GET /invoice-documents
Call attributes : invoiceid ; sellerid
Response attributes : pdf file
Recommended call frequency : One time after each 10 days (on 9, 19 and 29 of each month). This is because the invoices are generated before the payout.
Please note : Allows sellers to download up to 10 invoices at the same time in an archived file.
Count payments
GET /payments/count
Call attributes : paidAtMin ; paidAtMax ; paymentStates ; SellerId
Response attributes : count
Recommended call frequency : On each payout in order to reconcile payments with the amount received by the Seller on his bank account / On demand in order to check payment history.
Count payment operations
GET /operations/count
Call attributes : orderReference ; paidAtMin ; paidAtMax ; eventTypes ; states ; invoiceId
Response attributes : count
Recommended call frequency : Daily in order to monitor business accounting / On each payout in order to reconcile accouting items.
Retrieve payments
GET /payments
Call attributes : paidAtMin ; paidAtMax ; paymentStates ; page index ; page size ; SellerId
Response attributes : salesAmount ; commissionsAmount ; servicesAmount ; refundAmount ; securityDepositAmount ; totalAmount ; paidAt ; state ; stateMotive ; blockedAt ; salesChannel
Recommended call frequency : On each payout in order to retrieve payments with the amount received by the Seller on his bank account / On demand in order to check payment history.
Please note : Allows sellers to retrieve the payment overall for each payout. All operations are group by date, sales channel and payment status.
Retrieve payment operations
GET /operations
Call attributes : paidAtMin ; paidAtMax ; order reference ; event type ; states ; invoice id ; page index ; page size ; SellerId
Response attributes : salesAmount ; commissionsAmount ; servicesAmount ; refundAmount ; securityDepositAmount ; totalAmount ; paidAt ; state ; stateMotive ; blockedAt ; salesChannel
Recommended call frequency : On each payout in order to retrieve accouting items.
Please note : Allows sellers to retrieve all financial informations related to a payment (order, commissions, invoices, guarantee reserve...). Allows sellers to search for a financial operation (order/refund) and retrieves its details.