Invoicing at Oyster

This guide helps API consumers understand how invoicing works in Oyster and provides structure for integrating with invoicing related endpoints.

Oyster issues different invoice types depending on the product and scenario. Each invoice can expose both an invoice status and payment statuses for charge and payout flows.

Invoice types

EOR payroll

• Deposit
  • A refundable invoice issued upon hiring a Team Member.
  • Contains payroll components.
• Prefunding
  • Issued monthly, around the 11th.
  • An estimation of the payroll cost and not disputable.
  • Contains payroll components.
• Settlement
  • Issued monthly, around the 5th of the following month.
  • Charges the difference between actual payroll cost for the month and the prefunding amount.
  • Contains payroll components.
• Manual
  • Manually issued as needed.
• Scale
  • Contains only fees.

Contractors

Contractor invoices can either be invoiced in the contractor's or in Oyster’s name

• Invoices issued in the contractor’s name:
  • Issued individually per contractor and are not aggregated.
  • Each invoice has two payments:
    • Charge: paid by the customer to Oyster.
    • Payout: paid by Oyster to the contractor.
  • Invoice types include:
    • Contractor monthly payment
      • Around the 11th of the month (or between the 11th and end of month for new starters).
      • Charges the fixed contractor cost for the month.
    • PAYG (Pay-As-You-Go)
      • Issued as soon as a PAYG contractor creates an invoice in the platform.
      • Amount determined by the PAYG contractor.
    • Expenses
      • When enabled, issued shortly after the customer approves a contractor's expense.
      • Charges the approved expense amount.
• Invoices issued in Oyster’s name
  • Invoice types include:
    • Contractor fees
      • Fees associated with using Oyster platform to pay and manage contractors

Statuses

For each invoice, you can retrieve the invoice status and the payment status (for charge and payout). If you have any questions about integrating the Invoicing API, see the Managing Invoices guide. For information about the charge and payout status, see the Managing Payments guide.