Sync Accounting

patchhttps://api.flxpoint.com/fulfillment-requests/{fulfillmentRequestId}/accounting-sync

Use this when you want to update fulfillment request data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Update Fulfillment Request as synced to external system

Request

Bodyapplication/json

accountingSyncedboolean | null

specify whether or not it was synced to the external system

externalAccountingIdstring | null

identfier in the external system that identifies this Fulfillment Request

accountingErrorstring | null

any error encountered in syncing this `Fulfillment Request` to the external system

itemsarray[FulfillmentAccountingSyncItem]

list of `Fulfillment Request Items` synced in the external accounting system

idintegerrequired

id of `Fulfillment Request Item`

externalAccountingItemIdstring | null

identfier in the external sytem that identfies this `Fulfillment Request Item`

Example request

patch/fulfillment-requests/{fulfillmentRequestId}/accounting-sync

curl -X PATCH "https://api.flxpoint.com/fulfillment-requests/{fulfillmentRequestId}/accounting-sync" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "accountingSynced": true,
         "externalAccountingId": "string",
         "accountingError": "string",
         "items": [
           {
             "id": 0,
             "externalAccountingItemId": "string"
           }
         ]
       }'

Example body · application/json

{
  "accountingSynced": true,
  "externalAccountingId": "string",
  "accountingError": "string",
  "items": [
    {
      "id": 0,
      "externalAccountingItemId": "string"
    }
  ]
}

Responses

204No Content

No schema documented for this status.

400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "patch": {
    "summary": "Sync Accounting",
    "description": "Update Fulfillment Request as synced to external system",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/FulfillmentAccountingSyncRequest"
          },
          "examples": {
            "success-1": {
              "value": {
                "accountingSynced": true,
                "externalAccountingId": "TEST-221",
                "accountingError": null,
                "items": [
                  {
                    "id": 12312,
                    "externalAccountingItemId": "TEST-221-A"
                  }
                ]
              }
            },
            "error-1": {
              "value": {
                "accountingSynced": false,
                "accountingError": "Request rejected due to invalid Id"
              }
            }
          }
        }
      }
    },
    "responses": {
      "204": {
        "description": "No Content"
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight