Push an invoice

Overview

This page aims to showcase how to synchronize a specific invoice, the possible issues during the synchronization, and how to troubleshoot them.

1. Before pushing an invoice

The following requirements must be met before pushing an invoice to your accounting system:

• Either the entity setting accounting.ledger_account_ids.products must be specified, or each product listed on an invoice (both catalog products and inline products) must have the ledger_account_id specified.
• The accounting system must include tax rates with the same numerical values as used in the invoice in Monite.
• If the invoice includes special deductions or incentives, the entity setting accounting.tax_ids.deductions must be specified.

2. Run the synchronization

The synchronization automatically happens every 24 hours following the initial synchronization between Monite and the entity’s accounting system. This action maps all the related objects between Monite and the accounting system.

You can also trigger the data synchronization on demand by calling POST /accounting_connections/{connection_id}/sync:

1
curl -X POST 'https://api.sandbox.monite.com/v1/accounting_connections/fba2b...dfa/sync' \
2
     -H 'X-Monite-Version: 2024-05-25' \
3
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
4
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN'

The successful response confirms the synchronization was triggered. The processing time may vary according to the amount of data synchronized:

1
{
2
  "message": "Started connection data sync."
3
}

Monite will automatically push all invoices when they are moved from the draft to issued status.

3. Check for a specific invoice

The synchronization time may vary according to the size of the invoice. You can check the status of the synchronization by calling GET /accounting_synced_records?object_type=receivable&object_id={object_id}.

The query parameter object_type is mandatory. You can sort and filter the results by other fields. For the full list of available sort and filter parameters, see the GET /accounting_synced_records endpoint:

1
curl -X GET 'https://api.sandbox.monite.com/v1/accounting_synced_records?object_type=receivable&object_id=3fa85...fa6' \
2
     -H 'X-Monite-Version: 2024-05-25' \
3
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
4
     -H 'Authorization: Bearer YOUR_PARTNER_TOKEN'

The successful response returns the record of the synced document, as well as the synced_record_id:

1
{
2
  "data": [
3
    {
4
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5
      "created_at": "2024-08-26T17:40:28.012Z",
6
      "updated_at": "2024-08-26T17:40:28.012Z",
7
      "errors": {},
8
      "last_pulled_at": "2024-08-26T17:40:28.012Z",
9
      "object_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10
      "object_type": "product",
11
      "object_updated_at": "2024-08-26T17:40:28.012Z",
12
      "platform": "xero",
13
      "platform_object_id": "7ec6c435-8ed2-4a12-a2e2-2b86cfdc4407",
14
      "platform_updated_at": "2024-08-26T17:40:28.012Z",
15
      "provider": "provider_name",
16
      "provider_object_id": "e802714c-4218-4775-a569-3e6a10281a5f",
17
      "provider_updated_at": "2024-08-26T17:40:28.012Z",
18
      "sync_status": "pending"
19
    }
20
  ],
21
  "next_pagination_token": "eyJvcmRlciI6ImFzYyIsImxpbW...",
22
  "prev_pagination_token": null
23
}

Troubleshooting

Failed syncs return the errors field, which contains the error status with details:

1
{
2
  "data": [
3
    {
4
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5
      "created_at": "2024-08-26T17:40:28.012Z",
6
      "updated_at": "2024-08-26T17:40:28.012Z",
7
      "errors": {},
8
      "last_pulled_at": "2024-08-26T17:40:28.012Z",
9
      "object_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10
      "object_type": "product",
11
      "object_updated_at": "2024-08-26T17:40:28.012Z",
12
      "platform": "xero",
13
      "platform_object_id": "7ec6c435-8ed2-4a12-a2e2-2b86cfdc4407",
14
      "platform_updated_at": "2024-08-26T17:40:28.012Z",
15
      "provider": "provider_name",
16
      "provider_object_id": "e802714c-4218-4775-a569-3e6a10281a5f",
17
      "provider_updated_at": "2024-08-26T17:40:28.012Z",
18
      "sync_status": "pending"
19
    }
20
  ],
21
  "next_pagination_token": "eyJvcmRlciI6ImFzYyIsImxpbW...",
22
  "prev_pagination_token": null
23
}

Here are some possible reasons for errors and the suggested approach:

You can re-try to push the invoice manually by calling POST /accounting_synced_records/{synced_record_id}/push. This action requires the synced_record_id of the related error entry.

If you continue to experience issues and need further assistance with the accounting integration, please contact our Support Team.