Reference
1.0.0
OAS 3.0.0

Acctual API

Download OpenAPI Spec
Base URL
https://sandbox.acctual.com/v1/
Client Libraries
Shell
Ruby
Node.js
PHP
Python
C
More
Shell cURL

Billing​

Endpoints
POST/billingPUT/billingPATCH/billing

Fetch bills​

Body
application/json
userId
required
string
example: 4db95f7a-b1f1-4949-8439-b6a92b19a126
Responses
  • 200
POST/billing
Shell cURL

Add bill​

Body
application/json
billInfo
required
object
anyOf
Responses
  • 200
PUT/billing
Shell cURL

Update bill​

Body
application/json
billInfo
required
object
anyOf
Responses
  • 200
PATCH/billing
Shell cURL

Invoicing​

Endpoints
POST/invoicingPUT/invoicingPATCH/invoicing

Company​

Endpoints
POST/companyPUT/companyGET/company/{companyId}

Users​

Endpoints
POST/usersGET/users/{userId}PUT/users/{userId}

ERP Contacts​

Endpoints
GET/erpContacts

Fetch ERP Contacts​

Query Parameters
  • userId
    required
    string
    example: user-123
Responses
  • 200
GET/erpContacts
Shell cURL

ERP Connection​

Endpoints
PUT/erpConnect

Connect ERP system​

Body
application/json
userId
required
string
example: 4db95f7a-b1f1-4949-8439-b6a92b19a126
accessToken
required
string
example: 7ad_KMOFUG-PAdFwYYoqn-sSPWg7pVUHoMi5jOcVWIYMXlUQok3fVQ
integrationType
required
string · enum
example: xero
  • xero
  • quickbooks-online
Responses
  • 200
PUT/erpConnect
Shell cURL
No Body

BillPayload​

{} BillPayload
billId
integer
example: 2554
userId
required
string
example: 4db95f7a-b1f1-4949-8439-b6a92b19a126
erpContactId
required
string
example: 3c499419-0341-4cde-8979-c870bc456f30
erpContactName
required
string
example: MangoDCA, Inc.
invoiceNumber
required
string
example: INV-00142
invoiceLink
string
example: https://{service}.storage/id
invoiceDate
required
string
example: 2023-11-09
dueDate
required
string
example: 2023-11-30
paidDate
string
example: 2023-12-30
amount
required
number · float
example: 5600.00
glCategoryMergeId
required
string
example: E2961B75-CD6B-44C7-8017-0FC6B2FAB0C1
glCategoryName
string
example: Contract Labour
memo
string
example: Software development services for accounting API
billStatus
required
string · enum
  • draft
  • ready
  • paid
tokenId
required
integer
example: 54482
symbol
string
example: USDC
network
string
example: ETHEREUM
networkTokenId
string
example: 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
paidFromAddress
required
string
example: 0xfb6D1e425b9eD657567D79197B392679E32d5e61
paidToAddress
required
string
example: 0xf7978845d4443d77a000F87D2018eC2A9B12067b
transactionHash
string
example: 0xa58eda2d99947208e5776ba815b9ad34f538ebaa9e0547c88a7837bd82fcb605
transactionLink
string
example: https://etherscan.io/tx/0xa58eda2d99947208e5776ba815b9ad34f538ebaa9e0547c88a7837bd82fcb605
safeTransactionHash
string
example: 0xeb457857ab80fff197f5ab40b4e1f0e1c23dd9bcc4499882bea7ec40ebe8bc26
paidTime
string
example: 2023-11-29T14:27:13Z
createdAt
string
example: 2023-11-01T23:11:52Z
updatedAt
string
example: 2023-11-01T23:11:52Z

PostBillingRequest​

{} PostBillingRequest
userId
required
string
example: 4db95f7a-b1f1-4949-8439-b6a92b19a126

PostBillingResponse​

{} PostBillingResponse
bills
array
anyOf